README.md

@gov.au/direction-links

Use direction links to link up and down within the DOM or back to a parent page.

Contents

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

---

Install

yarn add @gov.au/direction-links

npm install @gov.au/direction-links

⬆ back to top

---

Usage

• React

⬆ back to top

---

React

Usage:

import AUdirectionLink from './direction-links.js';

<AUdirectionLink link="/next/page/" text="Continue" />

All props:

<AUdirectionLink
  text="Submitting"    {/* The text of the link */}
  link="link/to/page"  {/* The href link, optional */}
  direction="top"      {/* The direction the link goes */}
  dark={ false }       {/* A dark variation of the component */}
  linkComponent="a"    {/* The component used for the link, optional */}
  attributeOptions     {/* Any other attribute options */}
/>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

---

Dependency graph

direction-links
└─ core

⬆ back to top

---

Tests

The visual test: https://auds.service.gov.au/packages/direction-links/tests/site/

⬆ back to top

---

Release History

• v3.0.1 - Update core package dependency to use the latest version
• v3.0.0 - Changed direction links arrow icon to be inside a span, making use of aria-hidden so the arrow is not read by screen readers
• v2.2.0 - Remove --save-dev flag from readme instructions
• v2.1.9 - Removed unused Fragment React import
• v2.1.8 - Resolve autoprefixer warning
• v2.1.7 - Fix pancake build path
• v2.1.6 - Updated deprecated text-decoration-skip property to text-decoration-skip-ink
• v2.1.5 - Removed uikit references
• v2.1.4 - Update dependencies
• v2.1.3 - Removing web pack dev server, updating dependencies
• v2.1.2 - Fixed build scripts for Windows
• v2.1.1 - Replace node-sass with sass
• v2.1.0 - React router support
• v2.0.3 - Update dependencies
• 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

};