@gov.au/progress-indicator

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@gov.au/progress-indicator
738913.1.83 years ago7 years agoMinified + gzip package size for @gov.au/progress-indicator in KB

Popular Searches

Readme

@gov.au/progress-indicator ============
Indicator of progress through a multitude of pages mostly used for forms.

Contents

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

Install

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

Usage

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

React

Usage: ```jsx import AUprogressIndicator from './progress-indicator.js'; { 
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 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. ā¬† back to top ----------------------------------------------------------------------------------------------------------------------------------------------------------------

Dependency graph

```shell progress-indicator ā””ā”€ core ``` ā¬† back to top ----------------------------------------------------------------------------------------------------------------------------------------------------------------

Tests

The visual test: https://auds.service.gov.au/packages/progress-indicator/tests/site/ ā¬† back to top ----------------------------------------------------------------------------------------------------------------------------------------------------------------

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 ----------------------------------------------------------------------------------------------------------------------------------------------------------------

License

Copyright (c) Commonwealth of Australia. Licensed under MIT. ā¬† back to top
};