Components
API Reference

API Reference

Merchants contextually understand the definition of an item through an overlay, that can be interactive, when clicking on the trigger.

Parameters

props

  • Type: @vtex/shoreline-components.ContextualHelpProps & @types/react.React.RefAttributes<typescript.HTMLDivElement>

Props

children (optional)

Children prop

  • Type: @types/react.React.ReactNode

label

aria-abel for the contextual help trigger

  • Type: string

narrow (optional)

Controls the padding of the contextual help popover. This prop defines whether it should be narrow or not. It is not narrow by default.

  • Type: boolean

  • Default: false

View source (opens in a new tab)