This package has been deprecated

    Author message:

    The Australian Government Design System has been decommissioned. Visit https://community.digital.gov.au/t/dta-design-system-has-been-decommissioned/4649 for more information.

    @gov.au/footer

    3.0.6 • Public • Published

    @gov.au/footer

    Footers help users who reach the bottom of a page without finding what they want.

    Contents


    Install

    yarn add @gov.au/footer
    npm install @gov.au/footer

    back to top


    Usage

    back to top


    React

    Usage:

    import AUfooter, { AUfooterNav, AUfooterEnd } from './footer.js';
    
    <AUfooter>
      <AUfooterNav>
        au-footer__navigation
      </AUfooterNav>
      <AUfooterEnd>
        au-footer__end
      </AUfooterEnd>
    </AUfooter>

    All props:

    <AUfooter
      alt={ false }     {/* An alternate variation of the component */}
      dark={ false }    {/* A dark variation of the component */}
      attributeOptions  {/* Any other attribute options */}
    />
    
    <AUfooterNav
    	ariaLabel={ 'footer' } {/* Aria-label attribute on the <nav> element */}
    />

    (💡 additional props are spread onto the component)

    For more details have a look at the usage example.

    back to top


    Dependency graph

    footer
    └─ core

    back to top


    Tests

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

    back to top


    Release History

    • v3.0.6 - Update core package dependency to use the latest version
    • v3.0.5 - Remove --save-dev flag from readme instructions
    • v3.0.4 - Removed word navigation from aria-label in <nav> element
    • v3.0.3 - Removed unused Fragment React import
    • v3.0.2 - Removed uikit references
    • v3.0.1 - Placed the au-footer__end inside a row and col-sm-12
    • v3.0.0 - .au-footer-end no longer needs to follow .au-footer-navigation
    • v2.1.9 - Add role="contentinfo" attribute on footer
    • v2.1.8 - Remove role="contentinfo" attribute on <footer>
    • v2.1.7 - Added an aria-label attribute to the nav element
    • v2.1.6 - Update dependencies
    • v2.1.5 - Removing web pack dev server, updating dependencies
    • v2.1.4 - Fixed build scripts for Windows
    • v2.1.3 - Replace node-sass with sass
    • v2.1.2 - Change npm run watch browser-sync location
    • v2.1.1 - Update dependencies
    • v2.1.0 - Allow footer end to not be a nav element
    • v2.0.2 - Change homepage 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
    • 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

    };

    Install

    npm i @gov.au/footer

    DownloadsWeekly Downloads

    129

    Version

    3.0.6

    License

    MIT

    Unpacked Size

    36.7 kB

    Total Files

    11

    Last publish

    Collaborators

    • rmullen