Skip to content

Commit 2ea245e

Browse files
authored
docs(overlayTrigger): fix misleading example (#251)
Component does not accept "placement" prop, so remove it from the example.
1 parent 7018d3c commit 2ea245e

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/components/overlay-trigger/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@
1010
| overlay | node | Supply the preferred component to appear as a Popover |
1111
| trigger | oneOf(['hover', 'click']) | The user event on which the action is invoked |
1212
| delay | number | You can choose to apply a delay on the Popover. The default is 800ms. |
13+
| className | string | Use to specify any additional classes to the component. |
1314

1415
## Examples
1516

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

1819
```jsx
1920
<OverlayTrigger
20-
placement="top"
2121
overlay={
2222
<Popover>
23-
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
24-
</Popover> }
23+
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
24+
</Popover> }
2525
>
2626
Hover me!
2727
</OverlayTrigger>

0 commit comments

Comments
 (0)