README.md

@gov.au/buttons

Buttons signal action. Use them to move the user through the service.

Contents

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

---

Install

yarn add @gov.au/buttons

npm install @gov.au/buttons

⬆ back to top

---

Usage

• React

⬆ back to top

---

React

Usage:

import AUbutton from './buttons.js';

<AUbutton>Continue</AUbutton>

All props:

<AUbutton
  children          {/* Anything inside */}
  as=""             {/* The kind of button, 'secondary','tertiary', optional */}
  block={ true }    {/* The block option to make the button fill the available width, optional */}
  type="submit"     {/* The type attribute, optional */}
  dark={ false }    {/* A dark variation of the component */}
  link              {/* If a link is set the button will render as a link */}
  linkComponent="a" {/* The component used for the link, optional */}
></AUbutton>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

---

Dependency graph

buttons
└─ core

⬆ back to top

---

Tests

The visual test: https://auds.service.gov.au/packages/buttons/tests/site/

⬆ back to top

---

Release History

• v3.0.8 - Update core package dependency to use the latest version
• v3.0.7 - Remove --save-dev flag from readme instructions
• v3.0.6 - Removed unused Fragment React import
• v3.0.5 - Removed uikit references
• v3.0.4 - Update dependencies
• v3.0.3 - Removing web pack dev server, updating dependencies
• v3.0.2 - Fixed build scripts for Windows
• v3.0.1 - Replace node-sass with sass
• v3.0.0 - Add 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.2 - Fixed issue with secondary button hover IE8 312
• v1.0.1 - Fixed specificity issue when combined with body 197
• v1.0.0 - Moved to AU namespace, added new color themes and spacing
• v0.5.0 - Added pancake-react plugin, ES5 main file
• v0.4.0 - Added react component
• v0.3.0 - Fixed px height, added more robust CSS code
• v0.2.0 - Added block modifier
• v0.1.0 - 💥 Initial version

⬆ back to top

---

License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

⬆ back to top

};