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
The contents of the ContextualHelp.
The size of the ContextualHelp button.
The props for the Popover
The visual style of the ContextualHelp.
The element to associate the button with. The value of this attribute must be the id of a
in the same document.
The inline style for the element. A function may be provided to compute the style based on component state.
Whether the button is disabled.
Whether the element should receive focus on render.
The behavior of the button when used in an HTML form.
The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.
Indicates how to encode the form data that is submitted.
Indicates the HTTP method used to submit the form.
Indicates that the form is not to be validated when it is submitted.
Overrides the target attribute of the button's form owner.
The value associated with the button's name when it's submitted with the form data.
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.
The CSS className for the element. A function may be provided to compute the class based on component state.
Submitted as a pair with the button's value as part of the form data.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Whether the overlay is open by default (controlled).
Whether the overlay is open by default (uncontrolled).
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.
The additional offset applied along the main axis between the element and its anchor element.
The additional offset applied along the cross axis between the element and its anchor element.
The placement of the popover with respect to its anchor element.