{{tweet}} and {{follow}}
Twitter handlebars helpers, for adding {{tweet}} and {{follow}} buttons to your web projects.
See dev.twitter.com for more information.
Installation
Use npm to install the package: npm i handlebars-helper-twitter
.
Register the helper
In your project's Gruntfile, to register the helper add handlebars-helper-twitter
to the helpers
property in the Assemble task or target options:
grunt;
Usage
First, visit dev.twitter to copy/paste the necessary script into your templates. It looks like this (you probably shouldn't use this one, get the latest directly from twitter)
Now that the helper is registered, and the necessary script is in your templates, you may begin using it in your templates.
{{follow user="upstage" repo="upstage" type="star"}}{{tweet url="http://assemble.io" via="assemblejs" related="jonschlinkert:Assemble core team"}}
Options
The following hash options may be passed to the helper, in the form of foo="value"
:
Tweet button
url
Type: String
Default: http://assemble.io
URL of the page to share.
via
Type: String
Default: assemblejs
Screen name of the user to attribute the Tweet to.
related
Type: String
Default: jonschlinkert:Assemble core team
Related accounts. Example:
{{tweet url="http://assemble.io" via="assemblejs" related="jonschlinkert:Assemble core team"}}
Follow button
user
Type: String
Default: assemblejs
The Twitter username. Example: jonschlinkert
.
color
Type: String
Default: #0069D6
Hex value to use for the link color.
count
Type: String
Default: true
Whether or not to show the number of followers.
Author
Jon Schlinkert
License and Copyright
Licensed under the MIT License Copyright (c) Jon Schlinkert, contributors.