Extensions

Press shift + S to search API reference.

React component

Props

interface HeadingProps extends AllStylesProps, AriaProps
as"h1" | "h2" | "h3" | "h4" | "h5" | "h6"

The element that is rendered. Defaults to h3.

childrenReact.ReactNode | string

The contents of the heading.

classNameundefined | string

Additional class names to apply, separated by spaces.

dataAttributesDataAttributesProp

Data attributes that are spread onto the element, e.g. dataAttributes={{'data-*': '...'}}.

idundefined | string

The id attribute.

roleundefined | string

The role attribute.

sizeHeadingSizeProp

The size of the heading. Defaults to default. Can be a responsive prop object.

styleReact.CSSProperties

Additional styles.

variantHeadingVariant

The variant of the heading. Defaults to default.