From 34544329b10f0f5f0b7aba6a5a09301cd849d473 Mon Sep 17 00:00:00 2001 From: Noah Overcash Date: Fri, 5 Jan 2024 09:02:08 -0500 Subject: [PATCH] Document Popover children prop as required (#2196) * 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 --- lib/Popover/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/Popover/readme.md b/lib/Popover/readme.md index 9d8615c82..ce95704bb 100644 --- a/lib/Popover/readme.md +++ b/lib/Popover/readme.md @@ -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 `` 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 ``-component. See the ``-documentation for more information. | | noPadding | bool | Removes the default padding on the popover overlay. | false |