@gov.au/skip-link

@gov.au/skip-link

Provide skip links to navigation and content.

Contents

• Install
• Usage
• Dependency graph
• Tests
• Release History
• License

Install

yarn add @gov.au/skip-link

npm install @gov.au/skip-link

⬆ back to top

Usage

• React

⬆ back to top

React

Usage:

import AUskipLink from './skip-link.js';

<AUskipLink links={[
  {
    link: '#nav',
    text: 'Skip to navigation',
  },
  {
    link: '#content',
    text: 'Skip to content',
  },
]} />

All props:

<AUskipLink
  ariaLabel="skip links navigation" {/* Aria-label attribute on the root element */}
  links={[                          {/* All links inside a neat array */}
    {
      link: '#nav',                 {/* The href link of this link */}
      text: 'Skip to navigation',   {/* The text of the link */}
      onClick={ () => {} }          {/* A function to execute when the link is clicked, optional */},
    },
  ]},
/>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

Dependency graph

skip-link
└─ core

⬆ back to top

Tests

The visual test: https://auds.service.gov.au/packages/skip-link/tests/site/

⬆ back to top

Release History

• v2.0.17 - Update core package dependency to use the latest version
• v2.0.16 - Remove --save-dev flag from readme instructions
• v2.0.15 - Removed unused Fragment React import
• v2.0.14 - Resolve autoprefixer warning
• v2.0.13 - Fix pancake build path
• v2.0.12 - Updated deprecated text-decoration-skip property to text-decoration-skip-ink
• v2.0.11 - Removed uikit references
• v2.0.10 - Added an aria-label attribute to the nav element
• v2.0.9 - Update dependencies
• v2.0.8 - Removing web pack dev server, updating dependencies
• v2.0.7 - Fixed build scripts for Windows
• v2.0.6 - Replace node-sass with sass
• v2.0.5 - Change npm run watch browser-sync location
• v2.0.4 - Update dependencies
• v2.0.3 - Change homepage links
• v2.0.2 - Fix hover inside body
• 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

};