node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

@gov.au/header

@gov.au/header

Headers provide a consistent start to pages.

Contents


Install

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

⬆ back to top


Usage

⬆ back to top


React

Usage:

import Header from './header.js';
 
<Header title="Page title" />

All props:

<Header
    title="Page title"  {/* The headline content */}
    level="1"           {/* The headline tag level, h1-h6, optional */}
    subline="Subline"   {/* The subline content, optional */}
    theme="light"       {/* The theme, 'light', 'dark', optional */}
    hero={ false }      {/* The hero option, optional */}
/>

For more details have a look at the usage example.

⬆ back to top


Dependency graph

header
└─ core

⬆ back to top


Build

⬆ back to top


Tests

The visual test: http://uikit.apps.staging.digital.gov.au/packages/header/tests/site/

⬆ back to top


Release History

  • v1.2.0 - Added pancake-react plugin, ES5 main file, added children
  • v1.1.0 - Added react component
  • v1.0.0 - Removed the side spacing #147
  • v0.1.0 - 💥 Initial version

⬆ back to top


License

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

⬆ back to top

};