Headings

v3.0.0

Headings help to structure content on a page using relative visual prominence.

Released

History
View changes
Install
npm i @gold.au/headings
Tags
Requires
Contributors
  • Gary Broadbent avatar picture
  • Dominik Wilkowski avatar picture
  • Alex Page avatar picture
  • Simon Pascal Klein avatar picture
  • Patrick De Young avatar picture
  • Julian Fleetwood avatar picture
  • Trevor Brennan avatar picture

React Usage

import AUheading from '@gold.au/headings';

<AUheading size="xl" level="2">Display 2 on h2</AUheading>

Props

Prop name Type Description
size string The display size, 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'xxxl'
level string The semantic headline tag level, h1-h6

All other props are spread into the component

Exports

Name Type Description
AUheading default The heading component

node_modules import

import AUheading from '@gov.au/heading';

pancake import

import AUheading from './heading';