mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
2.1 KiB
Executable File
2.1 KiB
Executable File
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
-
Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/alfresco-login/alfresco-login.html">
-
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.
-
$ [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
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
History
For detailed changelog, check Releases.