InformationOverlay
The InformationOverlay provides additional information via an overlay, the
position of which can be adjusted. According to the type of information, the
variant can be set. The trigger consists of an icon and an optional text. By
default, the variant is neutral and the overlay is positioned on the bottom.
InformationOverlayProps
Signature:
export declare type InformationOverlayProps = & ( | );InformationOverlayBaseProps
, , , | Name | Type | Default | Description |
|---|---|---|---|
placement? | 'bottom' | The preferred placement for the overlay if there is enough space. If the preferred placement is not possible, the overlay will be positioned according to the available space. | |
color? | | | | | | 'neutral' or a container's color. | Controls the color of the styling and the trigger icon. |
InformationOverlayControlledProps
| Name | Type | Default | Description |
|---|---|---|---|
open | | Determines whether or not the overlay is open in a controlled scenario. | |
onOpenChange | (isOpen: ) => | | Callback fired when the open attribute changes in a controlled scenario. |
InformationOverlayUncontrolledProps
| Name | Type | Default | Description |
|---|---|---|---|
defaultOpen? | false | Determines whether or not the overlay is initially opened in an uncontrolled scenario. |
InformationOverlay.Content
You can use the InformationOverlay.Content component to render any content
inside the InformationOverlay overlay.
InformationContentProps
, InformationOverlay.Trigger
You can use the InformationOverlay.Trigger component to render a custom
trigger for the InformationOverlay overlay.
InformationOverlayTriggerProps
, | Name | Type | Default | Description |
|---|---|---|---|
'aria-label'? | | Optional aria-label to provide an additional description for the trigger. |