Skip to content

ContextualHelp

Props

API reference for ContextualHelp. For usage examples, see the React tab.

NameTypeDefault
children (required)ReactNode
defaultOpenboolean

Whether the overlay is open by default (uncontrolled).

isOpenboolean

Whether the overlay is open by default (controlled).

placementPlacementsbottom left

The placement of the element with respect to its anchor element.

size"lg" | "md" | "sm" | "xl" | "xs"md

Size of the trigger button icon.

variant"help" | "info"info

Icon variant displayed on the trigger button.