<twitter-button>
Web Component wrapper for Twitter's button using Polymer.
Demo
Install
Install the component using Bower:
$ bower install twitter-button --saveOr download as ZIP.
Usage
-
Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/twitter-button/dist/twitter-button.html">
-
Start using it!
<twitter-button></twitter-button>
Options
| Attribute | Options | Description |
|---|---|---|
text |
string | The text displayed on the tweet |
type |
share, follow, hashtag, mention
|
The type of button |
href |
string | The URL displayed on the tweet |
user |
string | The user displayed on the tweet and in the @mention |
hashtag |
string | The hashtag displayed on the tweet |
See Twitter's official documentation.
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-pagesbranch.$ 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.
License
MIT License © Zeno Rocha
