@digital.nsw/header
Headers provide a consistent start to pages.
Contents
Install
yarn add @digital.nsw/header
npm install @digital.nsw/header --save-dev
Usage
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>
(
For more details have a look at the usage example.
Dependency graph
header
└─ core
Release History
- v0.1.0 -
💥 Initial version
License
Copyright (c) Commonwealth of Australia. Licensed under MIT.