@gov.au/direction-links

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@gov.au/direction-links
3.0.1a year ago5 years agoMinified + gzip package size for @gov.au/direction-links in KB

Readme

@gov.au/direction-links ============
Use direction links to link up and down within the DOM or back to a parent page.

Contents

----------------------------------------------------------------------------------------------------------------------------------------------------------------

Install

```shell yarn add @gov.au/direction-links ``` ```shell npm install @gov.au/direction-links ``` ā¬† back to top ----------------------------------------------------------------------------------------------------------------------------------------------------------------

Usage

ā¬† back to top ----------------------------------------------------------------------------------------------------------------------------------------------------------------

React

Usage: ```jsx import AUdirectionLink from './direction-links.js'; ``` All props: ```jsx 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

```shell 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
};