Skip to content

Commit

Permalink
Fixed relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
tshaddix committed Jan 7, 2018
1 parent 2841a7d commit 805bcfb
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ A search and select React.JS component for picking the perfect giphy.
## Table of Contents

- [Installation](#Installation)
- [Usage](#Usage)
- [Installation](#installation)
- [Usage](#usage)

## Installation

Expand All @@ -27,9 +27,9 @@ import {Selector, ResultSort, Rating} from "react-giphy-selector";

```

- [Selector](#Selector)
- [Rating](#Rating)
- [ResultSort](#ResultSort)
- [Selector](#selector)
- [Rating](#rating)
- [ResultSort](#resultSort)

### Selector

Expand All @@ -43,10 +43,10 @@ The selector component contains all of the search, display, and selection logic.

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.

- `apiKey: string`: [Your Giphy Project API Key]([Giphy API Key](https://developers.giphy.com/).
- `apiKey: string`: [Your Giphy Project API Key](https://developers.giphy.com/).
- `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.
- `rating?: Rating`: The maximum rating you want to allow in your search results. Use the exported [Rating](#Rating) enum for help. Default: `Rating.G`.
- `sort?: ResultSort`: The sort order of the search results. Use the helper enum [ResultSort](#ResultSort). Default: `ResultSort.Relevant`.
- `rating?: Rating`: The maximum rating you want to allow in your search results. Use the exported [Rating](#rating) enum for help. Default: `Rating.G`.
- `sort?: ResultSort`: The sort order of the search results. Use the helper enum [ResultSort](#resultsort). Default: `ResultSort.Relevant`.
- `limit?: number`: The number of results to return. Default: `20`.
- `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: `[]`.
- `queryInputPlaceholder?: string`: The placeholder text for the search bar text input. Default `'Enter search text'`.
Expand Down

0 comments on commit 805bcfb

Please sign in to comment.