Skip to content

Commit

Permalink
Document Popover children prop as required (#2196)
Browse files Browse the repository at this point in the history
* Document Popover children prop as required

This prop is required, as denoted by the component's prop-types.  The README should denote this requirement.

* oops

---------

Co-authored-by: John Coburn <[email protected]>
  • Loading branch information
ncovercash and JohnC-80 authored Jan 5, 2024
1 parent 988d17a commit 3454432
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/Popover/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const [open, setOpen] = useState(fale);
Name | Type | Description | Default | Required
--- | --- | --- | --- | ---
anchorRef | func, object | Pass a ref to an alternative anchor element. The anchor is the element that the popover attaches to. The `<Popover>` will automatically generate a ref that will be passed down to the trigger element via. the `renderTrigger`-prop. The default ref will be replaced by the ref passed to the `anchorRef`-prop. | |
children | func, node | Renders the contents of the popover overlay. Passing a function will enable accessing the same render-props that is passed to the `renderTrigger`-function. This is useful for e.g. passing down the `toggle`-function to a "close"-button inside the popover overlay. | |
children | func, node | Renders the contents of the popover overlay. Passing a function will enable accessing the same render-props that is passed to the `renderTrigger`-function. This is useful for e.g. passing down the `toggle`-function to a "close"-button inside the popover overlay. | | Yes
className | string | Applies a custom class name for the popover overlay. | |
modifiers | object | Pass modifiers for the internal `<Popper>`-component. See the `<Popper>`-documentation for more information. | |
noPadding | bool | Removes the default padding on the popover overlay. | false |
Expand Down

0 comments on commit 3454432

Please sign in to comment.