Skip to content

social-elements/twitter-button

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<twitter-button>

Web Component wrapper for Twitter's button using Polymer.

Demo

Twitter Button

Check it live.

Install

Install the component using Bower:

$ bower install twitter-button --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

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

    <link rel="import" href="bower_components/twitter-button/dist/twitter-button.html">
  3. 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.

  • 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 © Zeno Rocha