Skip to content

Commit

Permalink
docs(overlayTrigger): fix misleading example (#251)
Browse files Browse the repository at this point in the history
Component does not accept "placement" prop, so remove it from the example.
  • Loading branch information
gazdagergo authored Feb 6, 2018
1 parent 7018d3c commit 2ea245e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/components/overlay-trigger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@
| overlay | node | Supply the preferred component to appear as a Popover |
| trigger | oneOf(['hover', 'click']) | The user event on which the action is invoked |
| delay | number | You can choose to apply a delay on the Popover. The default is 800ms. |
| className | string | Use to specify any additional classes to the component. |

## Examples

Use to give rise to your `Popover` passed as `prop` to `overlay`.

```jsx
<OverlayTrigger
placement="top"
overlay={
<Popover>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</Popover> }
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</Popover> }
>
Hover me!
</OverlayTrigger>
Expand Down

0 comments on commit 2ea245e

Please sign in to comment.