HelpAndSupport API
API reference docs for theHelpAndSupportwidget. For examples and details on the usage of this widget, visit the widget demo page.
Props
| Props | Type | Description | Default |
|---|---|---|---|
children | ((menuState: { isOpen: boolean; triggerProps: TriggerProps<React.ElementType>; }) => React.ReactNode) | React.ReactNode | Accepts either a React node or a render function. The render function provides the menu's state (isOpen) and accessibility/interaction props (triggerProps) for the trigger. | _ |
closeButtonPropsForMobile? | object | To render and customise Sheet close button contains label and onClick | _ |
closeButtonPropsForMobile.label | string | Aria label content for the close Icon button | _ |
closeButtonPropsForMobile.onClick | function | Callback function to be invoked when the close button is clicked. | _ |
popoverMaxWidth? | number | The max width of the dropdown panel popover. | 280 |
popoverOffset? | number | The offset of the dropdown panel popover. | 8 |
popoverPlacement? | 'bottom' | 'bottom-start' | 'bottom-end'| 'top-start'| 'top-end' | The placement of the dropdown panel popover relative to the dropdown menu trigger. | 'bottom' |
strategy? | 'absolute' | 'fixed' | The strategy used to position the floating element. | 'absolute' |
onClose? | function | Callback triggered on closing the popover and will activate upon pressing "Esc" or clicking on the overlay. | _ |