{`npm install @nib-components/heading\n`}
\n {`import Heading from '@nib-components/heading';\n`}
\n {`\n \n Heading 1\n \n \n Heading 2, but h4 element\n \n \n Dynamic heading sizing\n \n \n`}
\n {`Prop`} | \n{`Type`} | \n{`Default`} | \n{`Description`} | \n
---|---|---|---|
{`number or object`} | \n\n | {`The heading size. Can be made responsive by passing an object of breakpoints. Value(s) must be one of `} | \n |
{`string or Component`} | \n\n | {`The heading component. What DOM element should your heading be. Optional if `} | \n |
{`string or function`} | \n{`Each heading level has a default color defined in tokens.`} | \n{`The heading color. Can be any of the named `}{`color tokens`}{` or `}{`theme selectors`}{`.`} | \n|
{`string`} | \n{`Dependent on `} | \n {`Switches the font-family for the heading. This only works with the `} | \n |
{`string or object`} | \n\n | {`Set the alignment of the text. Can be made responsive by passing an object of breakpoints. Values must be one of `} | \n
{`The Heading component should be used for all heading elements and headings should be sentence case only.`}
\n{`There should only ever be one `}
{`Be sure not to exceed `}{`70 characters`}{` and avoid using hyphens (`}
{`The Heading component supports our two brand fonts; Grenette Pro `}{`(serif)`}{` and Buenos Aires `}{`(sans-serif)`}{`. The default value for font type is dependent on the `}
{`Size`} | \n{`Default fontType`} | \n
---|---|
{`Grenette Pro`}{` should be used almost exclusively for large headinngs. It should be used only for page or section headings, or where nib's brand voice is used to communicate a value proposition. See our `}{`foundational typography guidelines`}{` for more information.`}
\n{`The variable default for `}
{`\n Dynamic heading sizing, inconsistent font\n \n`}
\n {`To prevent this swapping, add an explicit `}
{`\n Dynamic heading sizing, consistent font\n \n`}
\n {`Headings have no margins by default. To add margins to paragraphs please use our `}{`Stack`}{` layout component for consistent vertical spacing.`}
\n{`There are times when you may want to include a certain `}
{`This is especially important for ensuring that pages follow a logical, semantic heading hierarchy.`}
\n{`Responsive heading size is possible by supplying an object of breakpoints to the `}
{`If longer text is required, consider using the `}{`Copy`}{` component instead.`}
\n