API Reference
Heading is used to define levels of typography
<Heading>Headline text</Heading>
Parameters
props
- Type:
@vtex/shoreline-components.HeadingProps & @types/react.React.RefAttributes<typescript.HTMLHeadingElement>
Props
asChild (optional)
Children composition
-
Type:
boolean -
Default:
false
level (optional)
Heading level
-
Type:
1 | 2 | 3 | 4 | 5 | 6 -
Default:
3
variant (optional)
Heading variant
-
Type:
display1 | display2 | display3 | display4 | context -
Default:
'context'