Interface HeadingProps

Based on this heading component: https://react.docs.search.io/components/heading https://mui.com/material-ui/react-typography/

interface HeadingProps {
    centered?: boolean;
    children?: ReactNode;
    level: HeadingLevel;
    noBottomMargin?: boolean;
    noTopMargin?: boolean;
    styleLike?: HeadingLevel;
    truncate?: boolean;
    upperCased?: boolean;
}

Hierarchy

PropsWithChildren
- HeadingProps

Index

Properties

centered? children? level noBottomMargin? noTopMargin? styleLike? truncate? upperCased?

Properties

`Optional`centered

centered?: boolean

`Optional`children

children?: ReactNode

level

level: HeadingLevel

`Optional`noBottomMargin

noBottomMargin?: boolean

`Optional`noTopMargin

noTopMargin?: boolean

`Optional`styleLike

styleLike?: HeadingLevel

Use this to make the level smaller/larger than it would be according to the HTML tag. Used for a11y to not break the document outline.

`Optional`truncate

truncate?: boolean

If true, the heading will be truncated with an ellipsis if it overflows.

`Optional`upperCased

upperCased?: boolean

If true, the heading will be upper-cased (using CSS for a11y reasons).