Introduction

This repository contains an element for the Alfresco login REST API. The element is designed for use in Polymer 1.0.

Install

Install the component using Bower:

$ bower install alfresco-login --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
    
  2. Import Custom Element:

    <link rel="import" href="bower_components/alfresco-login/alfresco-login.html">
    
  3. Start using it!

    <alfresco-login></alfresco-login>
    

Options

Attribute Options Default Description
method string GET Type of HTTP Request.

Events

Event Description
onsubmit The event is fired if a user signs in Alfresco successfully.
--- ---
onerror The event is fired if a user is not signed into Alfresco..

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
    
  • Install local dependencies:

    $ bower install && npm install
    
  • To test your project, start the development server and open http://localhost:8000.

    $ grunt server
    
  • To build the distribution files before releasing a new version.

    $ grunt build
    
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy
    

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License