ContextualHelp

Contextual help shows a user extra information about the state of an adjacent component. It explains a high-level topic about an experience and can point users to more information elsewhere.

Variants

A contextual help can use different variants.

Sizes

A contextual help can have different sizes.

Props

children

The contents of the ContextualHelp.

size?

The size of the ContextualHelp button.

Defaults to sm.
popoverProps?

The props for the Popover

variant?

The visual style of the ContextualHelp.

Defaults to help.
form?

The element to associate the button with. The value of this attribute must be the id of a in the same document.

style?

The inline style for the element. A function may be provided to compute the style based on component state.

isDisabled?

Whether the button is disabled.

autoFocus?

Whether the element should receive focus on render.

type?

The behavior of the button when used in an HTML form.

Defaults to 'button'.
formAction?

The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.

formEncType?

Indicates how to encode the form data that is submitted.

formMethod?

Indicates the HTTP method used to submit the form.

formNoValidate?

Indicates that the form is not to be validated when it is submitted.

formTarget?

Overrides the target attribute of the button's form owner.

value?

The value associated with the button's name when it's submitted with the form data.

isPending?

Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers.

className?

The CSS className for the element. A function may be provided to compute the class based on component state.

name?

Submitted as a pair with the button's value as part of the form data.

UNSAFE_backgroundColor?

Sets the background-color property.

If you want to use a token value from the SCALE, use the backgroundColor property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorActive?

Sets the background-color property when active.

If you want to use a token value from the SCALE, use the backgroundColorActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorFocus?

Sets the background-color property when focused.

If you want to use a token value from the SCALE, use the backgroundColorFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorHover?

Sets the background-color property when hovered.

If you want to use a token value from the SCALE, use the backgroundColorHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_border?

Sets the border property.

If you want to use a token value from the SCALE, use the border property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderActive?

Sets the border property when active.

If you want to use a token value from the SCALE, use the borderActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottom?

Sets the border-bottom property.

If you want to use a token value from the SCALE, use the borderBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomActive?

Sets the border-bottom property when active.

If you want to use a token value from the SCALE, use the borderBottomActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomFocus?

Sets the border-bottom property when focused.

If you want to use a token value from the SCALE, use the borderBottomFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomHover?

Sets the border-bottom property when hovered.

If you want to use a token value from the SCALE, use the borderBottomHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomLeftRadius?

Sets the border-bottom-left-radius property.

If you want to use a token value from the SCALE, use the borderBottomLeftRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomRightRadius?

Sets the border-bottom-right-radius property.

If you want to use a token value from the SCALE, use the borderBottomRightRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderFocus?

Sets the border property when focused.

If you want to use a token value from the SCALE, use the borderFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderHover?

Sets the border property when hovered.

If you want to use a token value from the SCALE, use the borderHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeft?

Sets the border-left property.

If you want to use a token value from the SCALE, use the borderLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftActive?

Sets the border-left property when active.

If you want to use a token value from the SCALE, use the borderLeftActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftFocus?

Sets the border-left property when focused.

If you want to use a token value from the SCALE, use the borderLeftFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftHover?

Sets the border-left property when hovered.

If you want to use a token value from the SCALE, use the borderLeftHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRadius?

Sets the border-radius property.

If you want to use a token value from the SCALE, use the borderRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRight?

Sets the border-right property.

If you want to use a token value from the SCALE, use the borderRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightActive?

Sets the border-right property when active.

If you want to use a token value from the SCALE, use the borderRightActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightFocus?

Sets the border-right property when focused.

If you want to use a token value from the SCALE, use the borderRightFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightHover?

Sets the border-right property when hovered.

If you want to use a token value from the SCALE, use the borderRightHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTop?

Sets the border-top property.

If you want to use a token value from the SCALE, use the borderTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopActive?

Sets the border-top property when active.

If you want to use a token value from the SCALE, use the borderTopActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopFocus?

Sets the border-top property when focused.

If you want to use a token value from the SCALE, use the borderTopFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopHover?

Sets the border-top property when hovered.

If you want to use a token value from the SCALE, use the borderTopHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopLeftRadius?

Sets the border-top-left-radius property.

If you want to use a token value from the SCALE, use the borderTopLeftRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopRightRadius?

Sets the border-top-right-radius property.

If you want to use a token value from the SCALE, use the borderTopRightRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadow?

Sets the box-shadow property.

If you want to use a token value from the SCALE, use the boxShadow property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowActive?

Sets the box-shadow property when active.

If you want to use a token value from the SCALE, use the boxShadowActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowFocus?

Sets the box-shadow property when focused.

If you want to use a token value from the SCALE, use the boxShadowFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowHover?

Sets the box-shadow property when hovered.

If you want to use a token value from the SCALE, use the boxShadowHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_color?

Sets the color property.

If you want to use a token value from the SCALE, use the color property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorActive?

Sets the color property when active.

If you want to use a token value from the SCALE, use the colorActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorFocus?

Sets the color property when focused.

If you want to use a token value from the SCALE, use the colorFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorHover?

Sets the color property when hovered.

If you want to use a token value from the SCALE, use the colorHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_columnGap?

Sets the column-gap property.

If you want to use a token value from the SCALE, use the columnGap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fill?

Sets the fill property.

If you want to use a token value from the SCALE, use the fill property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fillFocus?

Sets the fill property when focused.

If you want to use a token value from the SCALE, use the fillFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fillHover?

Sets the fill property when hovered.

If you want to use a token value from the SCALE, use the fillHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontFamily?

Sets the font-family property.

If you want to use a token value from the SCALE, use the fontFamily property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontSize?

Sets the font-size property.

If you want to use a token value from the SCALE, use the fontSize property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontWeight?

Sets the font-weight property.

If you want to use a token value from the SCALE, use the fontWeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gap?

Sets the gap property.

If you want to use a token value from the SCALE, use the gap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridAutoColumns?

Sets the grid-auto-columns property.

If you want to use a token value from the SCALE, use the gridAutoColumns property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridAutoRows?

Sets the grid-auto-rows property.

If you want to use a token value from the SCALE, use the gridAutoRows property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridColumnSpan?

Sets the grid-column-span property.

If you want to use a token value from the SCALE, use the gridColumnSpan property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridRowSpan?

Sets the grid-row-span property.

If you want to use a token value from the SCALE, use the gridRowSpan property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridTemplateColumns?

Sets the grid-template-columns property.

If you want to use a token value from the SCALE, use the gridTemplateColumns property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridTemplateRows?

Sets the grid-template-rows property.

If you want to use a token value from the SCALE, use the gridTemplateRows property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_height?

Sets the height property.

If you want to use a token value from the SCALE, use the height property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_lineHeight?

Sets the line-height property.

If you want to use a token value from the SCALE, use the lineHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_margin?

Sets the margin property.

If you want to use a token value from the SCALE, use the margin property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginBottom?

Sets the margin-bottom property.

If you want to use a token value from the SCALE, use the marginBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginLeft?

Sets the margin-left property.

If you want to use a token value from the SCALE, use the marginLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginRight?

Sets the margin-right property.

If you want to use a token value from the SCALE, use the marginRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginTop?

Sets the margin-top property.

If you want to use a token value from the SCALE, use the marginTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginX?

Sets the horizontal margin (margin-left and margin-right) property.

If you want to use a token value from the SCALE, use the marginX property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginY?

Sets the vertical margin (margin-top and margin-bottom) property.

If you want to use a token value from the SCALE, use the marginY property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_maxHeight?

Sets the max-height property.

If you want to use a token value from the SCALE, use the maxHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_maxWidth?

Sets the max-width property.

If you want to use a token value from the SCALE, use the maxWidth property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_minHeight?

Sets the min-height property.

If you want to use a token value from the SCALE, use the minHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_minWidth?

Sets the min-width property.

If you want to use a token value from the SCALE, use the minWidth property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_padding?

Sets the padding property.

If you want to use a token value from the SCALE, use the padding property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingBottom?

Sets the padding-bottom property.

If you want to use a token value from the SCALE, use the paddingBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingLeft?

Sets the padding-left property.

If you want to use a token value from the SCALE, use the paddingLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingRight?

Sets the padding-right property.

If you want to use a token value from the SCALE, use the paddingRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingTop?

Sets the padding-top property.

If you want to use a token value from the SCALE, use the paddingTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingX?

Sets the horizontal padding (padding-left and padding-right) property.

If you want to use a token value from the SCALE, use the paddingX property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingY?

Sets the vertical padding (padding-top and padding-bottom) property.

If you want to use a token value from the SCALE, use the paddingY property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_rowGap?

Sets the row-gap property.

If you want to use a token value from the SCALE, use the rowGap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_stroke?

Sets the stroke property.

If you want to use a token value from the SCALE, use the stroke property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_width?

Sets the width property.

If you want to use a token value from the SCALE, use the width property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

isOpen?

Whether the overlay is open by default (controlled).

defaultOpen?

Whether the overlay is open by default (uncontrolled).

shouldFlip?

Whether the element should flip its orientation (e.g. top to bottom or left to right) when there is insufficient room for it to render completely.

Defaults to true.
offset?

The additional offset applied along the main axis between the element and its anchor element.

Defaults to 8.
crossOffset?

The additional offset applied along the cross axis between the element and its anchor element.

Defaults to 0.
placement?

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

Defaults to bottom.