You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ A search and select React.JS component for picking the perfect giphy.
7
7
8
8
## Table of Contents
9
9
10
-
-[Installation](#Installation)
11
-
-[Usage](#Usage)
10
+
-[Installation](#installation)
11
+
-[Usage](#usage)
12
12
13
13
## Installation
14
14
@@ -27,9 +27,9 @@ import {Selector, ResultSort, Rating} from "react-giphy-selector";
27
27
28
28
```
29
29
30
-
-[Selector](#Selector)
31
-
-[Rating](#Rating)
32
-
-[ResultSort](#ResultSort)
30
+
-[Selector](#selector)
31
+
-[Rating](#rating)
32
+
-[ResultSort](#resultSort)
33
33
34
34
### Selector
35
35
@@ -43,10 +43,10 @@ The selector component contains all of the search, display, and selection logic.
43
43
44
44
That said, there are a bunch of props that allow you to make this component your own. Note: the `?` included at the end of a property name denotes it as optional.
45
45
46
-
-`apiKey: string`: [Your Giphy Project API Key]([Giphy API Key](https://developers.giphy.com/).
46
+
-`apiKey: string`: [Your Giphy Project API Key](https://developers.giphy.com/).
47
47
-`onGifSelected?: (gifObject: IGifObject) => void`: The function to fire when a gif search result has been selected. The `IGifObject` represents the full [GIF Object](https://developers.giphy.com/docs/#gif-object) returned via the Giphy API.
48
-
-`rating?: Rating`: The maximum rating you want to allow in your search results. Use the exported [Rating](#Rating) enum for help. Default: `Rating.G`.
49
-
-`sort?: ResultSort`: The sort order of the search results. Use the helper enum [ResultSort](#ResultSort). Default: `ResultSort.Relevant`.
48
+
-`rating?: Rating`: The maximum rating you want to allow in your search results. Use the exported [Rating](#rating) enum for help. Default: `Rating.G`.
49
+
-`sort?: ResultSort`: The sort order of the search results. Use the helper enum [ResultSort](#resultsort). Default: `ResultSort.Relevant`.
50
50
-`limit?: number`: The number of results to return. Default: `20`.
51
51
-`suggestions?: string[]`: An array containing one-click searches to make it easy for your user. Will not show suggestions section if none are passed. Default: `[]`.
52
52
-`queryInputPlaceholder?: string`: The placeholder text for the search bar text input. Default `'Enter search text'`.
0 commit comments