Giter VIP home page Giter VIP logo

share-twitter's Introduction

share-twitter

Create a Twitter share url with ease

Install

$ yarn add share-twitter

Usage

const shareTwitter = require('share-twitter')

shareTwitter({
  text: 'Check this library to help you create share twitter url',
  url: 'https://github.com/bukinoshita/share-twitter',
})
// https://twitter.com/intent/tweet?text=Check%20this%20library%20to%20help%20you%20create%20share%20twitter%20url&url=https://github.com/bukinoshita/share-twitter

When add the url to a <a/> tag it should work like this

Examples

Check the examples

API

shareTwitter([options])

Returns a string

text

Type: string
Example: Hello%20World

Pre-populated UTF-8 and URL-encoded Tweet text. The passed text will appear pre-selected for a Twitter user to delete or edit before posting. The length of your passed Tweet text should not exceed 140 characters when combined with any passed hashtags, via, or url parameters. Passed Tweet text which causes the Tweet to exceed 140 characters in length will require additional editing by a Twitter user before he or she can successfully post.

url

Type: string
Example: https://bukinoshita.io

A fully-qualified URL with a HTTP or HTTPS scheme, URL-encoded. The provided URL will be shortened by Twitter’s t.co to the number of characters specified by short_url_length.

hashtags

Type: string
Example: nature,sunset

Allow easy discovery of Tweets by topic by including a comma-separated list of hashtag values without the preceding # character.

via

Type: string
Example: bukinoshita

A Twitter username to associate with the Tweet, such as your site’s Twitter account. The provided username will be appended to the end of the Tweet with the text “via @username”. A logged-out Twitter user will be encouraged to sign-in or join Twitter to engage with the via account’s Tweets. The account may be suggested as an account to follow after the user posts a Tweet.

related

Type: string
Example: javascript

Suggest additional Twitter usernames related to the Tweet as comma-separated values. Twitter may suggest these accounts to follow after the user posts their Tweet. You may provide a brief description of how the account relates to the Tweet with a URL-encoded comma and text after the username.

replyTo

Type: string
Example: 525001166233403393

The Tweet ID of a parent Tweet in a conversation, such as the initial Tweet from your site or author account.

Related

License

MIT © Bu Kinoshita

share-twitter's People

Contributors

dependabot[bot] avatar bukinoshita avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.