@gold.au/header

    5.0.0 • Public • Published

    @gold.au/header

    Headers provide a consistent start to pages.

    Contents


    Install

    yarn add @gold.au/header
    npm install @gold.au/header

    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


    Tests

    The visual test: https://auds.service.gov.au/packages/header/tests/site/

    back to top


    Release History

    • v4.1.13 - Header image should be a block element on XS and SM breakpoints (Fix based on the new grid breakpoints)
    • v4.1.12 - Remove --save-dev flag from readme instructions
    • v4.1.11 - Removed unused Fragment React import
    • v4.1.10 - Resolve autoprefixer warning
    • v4.1.9 - Fix pancake build path
    • v4.1.8 - Updated deprecated text-decoration-skip property to text-decoration-skip-ink
    • v4.1.7 - Removed uikit references
    • v4.1.6 - Update dependencies
    • v4.1.5 - Removing web pack dev server, updating dependencies
    • v4.1.4 - Removed border from header brand image on ie8, ie9 and ie10
    • v4.1.3 - AUheaderBrand without a link now defaults to div
    • v4.1.2 - Fixed build scripts for Windows
    • v4.1.1 - Replace node-sass with sass
    • v4.1.0 - React router support
    • v4.0.2 - Update dependencies
    • v4.0.1 - Added missing documentation
    • v4.0.0 - Added placeholder for Australian Government logo and optional grid layout
    • v3.0.2 - Change homepage link
    • v3.0.1 - Fix dependencies
    • v3.0.0 - Change to focus colour and border/muted color mix
    • v2.0.0 - Moved to AU namespace, added new color themes and spacing
    • 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

    };

    Install

    npm i @gold.au/header

    DownloadsWeekly Downloads

    2

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    62.1 kB

    Total Files

    11

    Last publish

    Collaborators

    • designsystemau
    • elisechant
    • dominikwilkowski