The ExternalOverlay component allows to indicate to the Sheet component instances currently presented that an overlay component out of Silk’s control is also present.
This allows to either include such overlay inside of the inert outside mechanism of the Sheet component instances, or to disable it to avoid any potential conflict.
<ExternalOverlay.Root />
Required | yes |
---|---|
Underlying HTML element | div |
Description
The root sub-component of the ExternalOverlay component.
It should be mounted or have its disabled
prop set to false
at the same time as the component it wraps gets mounted or its inert outside mechanism gets set up.
Required | no |
---|---|
Value type | boolean |
Default value | undefined |
Values description
true |
The underlying HTML element rendered is the child. |
---|---|
`false | undefined` |
Description
Defines whether the sub-component underlying HTML element is the default one or the one passed as child of the sub-component.
Usage
If the child is a React component rendering a HTML element:
React.forwardRef()
and pass the received ref to the rendered HTML element.