@gold.au/progress-indicator/README.md

Indicator of progress through a multitude of pages mostly used for forms.

@gold.au/progress-indicator
============

> Indicator of progress through a multitude of pages mostly used for forms.


## Contents

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


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


## Install


```shell
yarn add @gold.au/progress-indicator
```

```shell
npm install @gold.au/progress-indicator
```


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


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


## Usage


* [React](#react)


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


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


### React

Usage:

```jsx
import AUprogressIndicator from './progress-indicator.js';

<AUprogressIndicator items={[
  {
    link: 'forms/intro/',
    text: 'Introduction',
    status: 'done',
  },
  {
    link: 'forms/contacts/',
    text: 'Business Contacts',
    status: 'doing',
    li: {
      className: 'li-wrapping-class',
    },
  },
  {
    link: 'forms/casestudies/',
    text: 'Case Studies',
    status: 'todo',
  },
]} />
```

All props:

```jsx
<AUprogressIndicator
  dark={ false }             {/* A dark variation of the component */}
  linkComponent="a"          {/* The component used for the link, optional */}
  items={[                   {/* All steps in a neat array */}
    {
      link: 'forms/intro/',  {/* The link to this step, optional */}
      linkComponent: 'a',    {/* The component used for the link, optional */}
      text: 'Introduction',  {/* The name of this step */}
      status: 'done',        {/* The status of this step, can be: 'done', 'doing', 'todo' */}
      li: {},                {/* An object that will be spread onto the <li> tag, optional */}
      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](https://github.com/designsystemau/gold-design-system/tree/main/packages/progress-indicator/tests/react/index.js).


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


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


## Dependency graph

```shell
/progress-indicator
└─ /core
```


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

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


## Release History

* v3.1.8 - Update core package dependency to use the latest version
* v3.1.7 - Remove --save-dev flag from readme instructions
* v3.1.6 - Removed unused `Fragment` React import
* v3.1.5 - Removed uikit references
* v3.1.4 - Update dependencies
* v3.1.3 - Removing web pack dev server, updating dependencies
* v3.1.2 - Fixed build scripts for Windows
* v3.1.1 - Replace node-sass with sass
* v3.1.0 - Add support for react router
* v3.0.4 - Update dependencies
* v3.0.3 - Change React "Todo" label to "To do"
* v3.0.2 - Change homepage links
* v3.0.1 - Fix dependencies
* v3.0.0 - Change to focus colour and border/muted color mix
* v2.0.0 - Moved to AU namespace, added new color themes and spacing
* v1.0.0 - Fixing BEM issues with class names
* 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)**

# };