@digital.nsw/header

0.1.0 • Public • Published

@digital.nsw/header

Headers provide a consistent start to pages.

Contents


Install

yarn add @digital.nsw/header
npm install @digital.nsw/header --save-dev

back to top


Usage

back to top


React

Usage:

import AUheader, { AUheaderBrand } from './header.js';

<AUheader>
	<AUheaderBrand
		link="#"
		brandImage="http://placehold.it/256x80"
		brandImageAlt="Digital Transformation Agency"
	/>
</AUheader>

All props:

<AUheader
  alt={ false }       {/* An alternate variation of the component, optional */}
  dark={ false }      {/* A dark variation of the component, optional */}
  hero={ false }      {/* The hero option, optional, optional */}
/>

<AUheaderBrand
  title="Page title"      {/* The headline content, optional */}
  level="1"               {/* The headline tag level, h1-h6, optional */}
  subline="Subline"       {/* The subline content, optional */}
  brandImage="Page title" {/* The headline content, optional */}
  brandImageAlt="1"       {/* Brand image alt tag */}
  link="/"                {/* An optional link for the header brand, optional */}
  linkComponent="a"       {/* The component used for the link, optional */}
  children                {/* Anything inside */}
  attributeOptions        {/* Any other attribute options */}
></AUheaderBrand>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

back to top


Dependency graph

header
└─ core

back to top


Release History

  • v0.1.0 - 💥 Initial version

back to top


License

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

back to top

};

Package Sidebar

Install

npm i @digital.nsw/header

Weekly Downloads

0

Version

0.1.0

License

MIT

Unpacked Size

54.3 kB

Total Files

11

Last publish

Collaborators

  • bayleymauger
  • digital-design-system