# @gov.au/direction-links

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

Latest version **3.0.1** (published 2021-06-07) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @gov.au/direction-links
pnpm add @gov.au/direction-links
yarn add @gov.au/direction-links
bun add @gov.au/direction-links
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2021-06-07 |
| First published | 2017-03-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 5 |
| Unpacked size | 42.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 736 |
| Author | Commonwealth of Australia, DTA |
| Maintainers | pponnapalli, rmullen, rajghuman, kirih |
| Keywords | auds, pancake, pancake-module, sass, scss, css, gov.au, Commonwealth of Australia, design guide, design system, up, down, left, right, direction links, links |

## Links

- npm: https://www.npmjs.com/package/@gov.au/direction-links
- Repository: https://github.com/govau/design-system-components
- Homepage: https://designsystem.gov.au/components/direction-links
- Issues: https://github.com/govau/design-system-components/issues
- npm.io page: https://npm.io/package/@gov.au/direction-links

## Dependencies (5)

- [@gov.au/core](https://npm.io/package/@gov.au/core.md) ^4.0.0
- [@gov.au/pancake](https://npm.io/package/@gov.au/pancake.md) ~1
- [@gov.au/pancake-json](https://npm.io/package/@gov.au/pancake-json.md) ~1
- [@gov.au/pancake-sass](https://npm.io/package/@gov.au/pancake-sass.md) ~2
- [@gov.au/pancake-react](https://npm.io/package/@gov.au/pancake-react.md) ~1

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2021-06-07
- 1.0.0-next.5 (next) — 2018-02-12
- 3.0.0 — 2019-06-20
- 2.2.0 — 2019-05-01
- 2.1.9 — 2019-03-04
- 2.1.8 — 2019-02-25
- 2.1.7 — 2019-02-25
- 2.1.6 — 2019-02-22
- 2.1.5 — 2019-01-10
- 2.1.4 — 2018-08-22
- 2.1.3 — 2018-08-07
- 2.1.2 — 2018-07-13
- 2.1.1 — 2018-06-18
- 2.1.0 — 2018-06-13
- 2.0.3 — 2018-06-04
- … 12 more at https://npm.io/package/@gov.au/direction-links/versions

## README

@gov.au/direction-links
============

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


## Contents

* [Install](#install)
* [Usage](#usage)
* [Dependency graph](#dependency-graph)
* [Tests](#tests)
* [Release History](#release-history)
* [License](#license)


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


## Install


```shell
yarn add @gov.au/direction-links
```

```shell
npm install @gov.au/direction-links
```


**[⬆ back to top](#contents)**


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


## Usage


* [React](#react)


**[⬆ back to top](#contents)**


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


### React

Usage:

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

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

All props:

```jsx
<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](https://github.com/govau/design-system-components/tree/master/packages/direction-links/tests/react/index.js).


**[⬆ back to top](#contents)**


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


## Dependency graph

```shell
direction-links
└─ core
```


**[⬆ back to top](#contents)**


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


## Tests

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


**[⬆ back to top](#contents)**


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


## 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](#contents)**


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


## License

Copyright (c) Commonwealth of Australia.
Licensed under [MIT](https://raw.githubusercontent.com/govau/design-system-components/packages/core/master/LICENSE).


**[⬆ back to top](#contents)**

# };

---
_Source: https://npm.io/package/@gov.au/direction-links · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._