Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
src
tests
CHANGELOG.md
LICENSE
README.md
package-lock.json
package.json

README.md

@gov.au/headings

Class styles for display headings.

Contents


Install

yarn add @gov.au/headings
npm install @gov.au/headings --save-dev

⬆ back to top


Usage

⬆ back to top


React

Usage:

import AUheading from './headings.js';

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

All props:

<AUheading
  size="xl"             {/* The display size, 'xs', 'sm', 'md', 'lg', 'xl', 'xxl', 'xxxl' */}
  level="1"             {/* The semantic headline tag level, h1-h6 */}
  attributeOptions      {/* Any other attribute options */}
/>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top


Dependency graph

headings
└─ core

⬆ back to top


Tests

The visual test: https://uikit.service.gov.au/packages/headings/tests/site/

⬆ back to top


Release History

  • v2.0.8 - Update dependencies
  • v2.0.7 - Removing web pack dev server, updating dependencies
  • v2.0.6 - Fixed build scripts for Windows
  • v2.0.5 - Replace node-sass with sass
  • v2.0.4 - Change npm run watch browser-sync location
  • v2.0.3 - Update dependencies
  • v2.0.2 - Change headings link
  • v2.0.1 - Fix dependencies
  • v2.0.0 - Change to focus colour and border/muted color mix
  • v1.0.0 - Moved to AU namespace, added new color themes and spacing, moved to system fonts
  • v0.3.0 - Added pancake-react plugin, ES5 main file
  • v0.2.0 - Added react component
  • v0.1.0 - 💥 Initial version

⬆ back to top


License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};