Code Monkey home page Code Monkey logo

angular-aviary's Introduction

Angular Aviary SDK

AngularJS directive for Aviary SDK.

Copyright © 2016, Massimiliano Sartoretto

Find me on: alt text alt text alt text

Installation

You can choose your preferred method of installation:

  • Through bower: bower install angular-aviary --save
  • Through npm: npm install angular-aviary --save
  • Download from github: angular-aviary.min.js

Usage

Include both Aviary and angular-aviary.min.js in your application.

<script src="http://feather.aviary.com/imaging/v2/editor.js"></script>
<script src="bower_components/angular-aviary/angular-aviary.min.js"></script>

Add the module ngAviary as a dependency to your app module:

var myApp = angular.module('myapp', ['ngAviary']);

Configuration

To configure the module call the ngAviaryProvider.configure() method (e.g. inside your app's config() callback):

myApp.config(function(ngAviaryProvider) {
  ngAviaryProvider.configure({
    apiKey: 'my-awesome-api-key',
    theme: 'light',
    tools: 'all'
  })
});

For the full list of config options please refer to the official docs

ngAviary directive

Use the ngAviary directive to create a toggle that trigger Fetcher editor.

<a href="#"
   target-selector='<selector>'
   target-src='./image.png'
   on-save-button-clicked='onSaveButtonClicked(id)'
   on-save='onSave(id, newURL)'
   ng-aviary> Edit photo </a>

You can use the HTML element you prefer as long as it supports onClick event. (For a list of supported elements refer to the onCLick docs)

Options that allow you to handle the Aviary flow:

Attribute Description Required
targetSelector A string containing one or more CSS selector to query target image ✔️
targetSrc A string containing the url of the target image ✖️
onLoad Pass a function to run once the widget has all resources ready for a launch. ✖️
onReady Pass a function to be called once the editor has finished launching and is ready for user input. ✖️
onSaveButtonClicked Pass a function to be called before an image save happens, but after a user has clicked the save button, intending to save. ✖️
onSave Pass a function to be called when the image save is complete. ✖️
onClose Pass a function to be called when the editor is closed. isDirty parameter tells whether the editor was closed with unsaved changes. ✖️
onError The API can notify you of errors and you have the option to notify the user. They are otherwise silent. ✖️

angular-aviary's People

Contributors

aschroedersportsdigita avatar ishansharma avatar m00s avatar rabbiabram avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.