Skip to content

Commit

Permalink
✨ add a prop to pass Twitter api data directly
Browse files Browse the repository at this point in the history
  • Loading branch information
@PierreCapo
PierreCapo committed Aug 17, 2020
1 parent 8933315 commit 759949d
Show file tree
Hide file tree
Showing 6 changed files with 381 additions and 21 deletions.
30 changes: 17 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ Finally, it is recommended to wrap those components into PureComponent because s

### Instagram

**WARNING** as of summer 2020, Instagram has added a firewall to prevent scripts to access its unofficial API.
It's planned in the migrate and use the official Instagram API.

| Light | Dark |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| <image src="https://github.com/PierreCapo/react-native-socials/raw/master/images/screenshot_instagram.png" /> | <image src="https://github.com/PierreCapo/react-native-socials/raw/master/images/screenshot_instagram_dark.png" /> |
Expand Down Expand Up @@ -61,16 +64,17 @@ Unlike Instagram, the **Twitter API is not open**. It is needed that you registe

Props:

| Name | Type | Default | Description |
| --------------------- | ---------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | **Required** | Twitter post id |
| consumerKey | string | **Required** | OAuth 1.0 Twitter key that is granted when you [register your app on Twitter Portal](https://developer.twitter.com/en/docs/basics/authentication/oauth-1-0a) |
| consumerSecret | string | **Required** | OAuth 1.0 Twitter secret that is granted when you [register your app on Twitter Portal](https://developer.twitter.com/en/docs/basics/authentication/oauth-1-0a) |
| darkMode | bool | false | Toggle dark mode |
| language | string enum | "en" | Pick language for metadata of the post |
| onHashTagPress | (hashtag:string) => void | Redirect to webpage | Overrides default behavior when pressing an hashtag in a Tweet |
| onUserMentionPress | (userMention:string) => void | Redirect to webpage | Overrides default behavior when pressing a user mention in a Tweet |
| onLinkPress | (link:string) => void | Redirect to webpage | Overrides default behavior when pressing a link in a Tweet |
| cornerRadius | string enum | "small" | Chose the corner radius of UI elements in a post. Typically a post taking the whole width of the screen should have "big" whereas a post in a card should use the "small" value |
| containerBorderRadius | number | 0 | Border radius of the container of the UI element |
| onTweetPress | (tweetId:string) => void | Redirect to webpage | Overrides default behavior when pressing the tweet |
| Name | Type | Default | Description |
| -------------------------- | ---------------------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | string | **Required** | Twitter post id |
| consumerKey | string | **Required** | OAuth 1.0 Twitter key that is granted when you [register your app on Twitter Portal](https://developer.twitter.com/en/docs/basics/authentication/oauth-1-0a) |
| consumerSecret | string | **Required** | OAuth 1.0 Twitter secret that is granted when you [register your app on Twitter Portal](https://developer.twitter.com/en/docs/basics/authentication/oauth-1-0a) |
| darkMode | bool | false | Toggle dark mode |
| language | string enum | "en" | Pick language for metadata of the post |
| onHashTagPress | (hashtag:string) => void | Redirect to webpage | Overrides default behavior when pressing an hashtag in a Tweet |
| onUserMentionPress | (userMention:string) => void | Redirect to webpage | Overrides default behavior when pressing a user mention in a Tweet |
| onLinkPress | (link:string) => void | Redirect to webpage | Overrides default behavior when pressing a link in a Tweet |
| cornerRadius | string enum | "small" | Chose the corner radius of UI elements in a post. Typically a post taking the whole width of the screen should have "big" whereas a post in a card should use the "small" value |
| containerBorderRadius | number | 0 | Border radius of the container of the UI element |
| onTweetPress | (tweetId:string) => void | Redirect to webpage | Overrides default behavior when pressing the tweet |
| useCustomTweetExtendedData | Object | null | Use this prop when you have already fetched the Twitter data in the app, and you want to call the component with the Twitter data as prop that you already have fetched. This object needs to be **exactly** the response of the call to the Twitter API with the **?tweet_mode=extended** parameter, like: https://api.twitter.com/1.1/statuses/show/1265128375707983872.json?tweet_mode=extended |
Loading

0 comments on commit 759949d

Please sign in to comment.