https://github.com/mrbartusek/gif-picker-react
Tenor GIF Picker component for React ⚛️
https://github.com/mrbartusek/gif-picker-react
gif gif-picker react react-component react-library reactjs tenor tsup typescript
Last synced: 4 months ago
JSON representation
Tenor GIF Picker component for React ⚛️
- Host: GitHub
- URL: https://github.com/mrbartusek/gif-picker-react
- Owner: MrBartusek
- License: mit
- Created: 2022-12-10T17:44:37.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T16:04:37.000Z (over 1 year ago)
- Last Synced: 2024-04-25T00:20:05.238Z (about 1 year ago)
- Topics: gif, gif-picker, react, react-component, react-library, reactjs, tenor, tsup, typescript
- Language: TypeScript
- Homepage: http://dokurno.dev/gif-picker-react/
- Size: 18.9 MB
- Stars: 29
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Gif Picker React | [Live Demo](https://dokurno.dev/gif-picker-react/)
[][npm]
[](https://github.com/MrBartusek/gif-picker-react/actions)
[](https://bundlephobia.com/package/gif-picker-react)
[][npm]
[npm]: https://www.npmjs.com/package/gif-picker-react
An [Tenor](https://tenor.comt) GIF picker component for React applications that runs on [Tenor API V2](https://developers.google.com/tenor/guides/quickstart). This picker fits styling of [emoji-picker-react](https://www.npmjs.com/package/emoji-picker-react) and can be used next to it.
## What to know before using
- In order to access Tenor API you are **required** to provide API key. This is a free and simple process that takes less than 60 seconds.
- Tenor requires [attribution]([https://developers.google.com/tenor/guides/attribution]) from products that use their API. This
library comply with that rule by adding *Search Tenor* placeholder to the search bar.
## Installation
```bash
npm install gif-picker-react
```
## Obtaining Tenor API v2 key
In order to use `GifPicker` element you are required to provide Tenor API key via
`tenorApiKey` prop. To obtain this key please follow this simple guide:
1. Login in to [Google Cloud Console](https://console.cloud.google.com)
1. Create a [new project](https://console.cloud.google.com/projectcreate)
1. In Google Cloud Marketplace navigate to [Tenor API](https://console.cloud.google.com/marketplace/product/google/tenor.googleapis.com)
1. Click on `Enable`
1. In navigation menu go to *APIs and services* tab and select [Credentials](https://console.cloud.google.com/apis/credentials)
1. Click `+ create credentials` and create *API key*, copy generated API key
1. Pass this key as prop to `tenorApiKey`
## Usage
```js
import GifPicker from 'gif-picker-react';
function App() {
return (
);
}
```
## Props
The following props are accepted by the picker:
| Prop | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| tenorApiKey | `string` | **Required** | Tenor v2 API key, obtained from [Google Cloud Console](https://console.cloud.google.com) |
| onGifClick | `function` | | Callback function that is called when an gif is clicked. The function receives the [`TenorImage`](#tenorimage) object as a parameter. |
| theme | `Theme` | `Theme.LIGHT` | Controls the theme of the picker. If you are using Typescript you can use `Theme` enum. Possible values are `light`, `dark` and `auto`.
| autoFocusSearch | `boolean` | `true` | Controls the auto focus of the search input. |
| contentFilter | `ContentFilter` | `ContentFilter.OFF` | Controls the Tenor [Content filtering](https://developers.google.com/tenor/guides/content-filtering) options. If you are using Typescript you can use `ContentFilter` enum. Possible values are `high`, `medium`, `low`, `off` |
| clientKey | `string` | `gif-picker-react` | Name of your application. Used to differentiate multiple applications using same API key. |
| country | `string` | `US` | Specify the country of origin for the request. To do so, provide its two-letter [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) country code. |
| locale | `string (xx_YY)` | `en_US` | Specify the default language to interpret the search string. xx is the language's [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code, while the optional _YY value is the two-letter [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) country code.
| width | `number / string` | `350` | Controls the width of the picker. You can provide a number that will be treated as pixel size, or your any accepted css width as string.
| height | `number / string` | `450` | Controls the height of the picker. You can provide a number that will be treated as pixel size, or your any accepted css width as string.
| categoryHeight | `number / string` | `100` | Controls the height of the home page reaction category. You can provide a number that will be treated as pixel size, or your any accepted css width as string.
| initialSearchTerm | `string` | | Sets the initial search term when the picker is opened.
### TenorImage
This object is provided as an argument to callback specified in `onGifClick`:
| Property | Type | Description |
| ------------- | ---------- | ----------- |
| id | `string` | Tenor result identifier |
| tenorUrl | `string` | The full URL to view the post on [tenor.com](https://tenor.com/) |
| shortTenorUrl | `string` | Short URL to view the post on [tenor.com](https://tenor.com/) |
| description | `string` | Textual description of the content. You can use this do populate image object `alt` attribute |
| createdAt | `Date` | Date object that represents when this post was created. |
| tags | `string[]` | Array of tags for the post |
| url | `string` | Direct URL to the image source |
| height | `number` | Height of the image in pixels |
| width | `number` | Width of the image in pixels |
| preview | `TenorImagePreview` | Gif preview object with dimensions scaled down |
### TenorImagePreview
This object is used for displaying the preview image gifs in the picker. You can use it to render smaller and lower-resolution versions of the gifs.
| Property | Type | Description |
| ------------- | ---------- | ----------- |
| url | `string` | Direct URL to the preview image source |
| height | `number` | Height of the preview image in pixels |
| width | `number` | Width of the preview image in pixels |
This is an example `TenorImage` object:
```js
{
id: "16596569648018104856",
tenorUrl: "https://tenor.com/view/american-psycho-patrick-bateman-american-psycho-gif-7212093",
shortTenorUrl: "https://tenor.com/Eqmf.gif",
description: "American Psycho Patrick Bateman GIF",
createdAt: Date,
tags: [ "American Psycho", "Patrick Bateman", "American", "psycho"],
url: "https://media.tenor.com/5lLcKZgmIhgAAAAC/american-psycho-patrick-bateman.gif",
height: 240,
width: 244,
preview: {
url: "https://media.tenor.com/5lLcKZgmIhgAAAAM/american-psycho-patrick-bateman.gif",
height: 120,
width: 122
}
}
```
## Customization
### Custom Picker Width and Height
To customize the dimensions of the picker, use the height and width props. You can pass in a number that will be treated as pixel size, or your any accepted css width/height as string.
```jsx
```
```jsx
```
### CSS Variables
The picker can be customized via CSS variables. The root selector for the picker is `.GifPickerReact`, when overriding, make sure to provide a more specific selector.
The list of possible variables is quite extensive, but the main ones you may want to override are:
- `--gpr-bg-color` - Background color of the picker.
- `--gpr-text-color` - Font color on the picker.
- `--gpr-highlight-color` - Color on the hover on focus on some search bar, categories and gif.
You can find full list of all variables in [GifPickerReact.css](https://github.com/MrBartusek/gif-picker-react/blob/master/src/GifPickerReact.css).
## Contributing
Want to contribute to the project?
First of all, thanks! Check [`CONTRIBUTING.md`](CONTRIBUTING.md) for more details.