README.md

@gov.au/control-input

Control inputs include radio buttons and checkboxes. They allow users to select one or more options.

Contents

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

---

Install

yarn add @gov.au/control-input

npm install @gov.au/control-input --save-dev

⬆ back to top

---

Usage

• React

⬆ back to top

---

React

Usage:

import { AUcheckbox, AUradio } from './control-input.js';

<AUradio label="Yes" name="has_email" value="yes" />
<AUradio label="No" name="has_email" value="no" />
<AUradio label="Maybe" name="has_email" value="maybe" />

<AUcheckbox label="Has email?" name="has_email" />

All props:

<AUradio
  label="The label"  {/* The label of the radio button */}
  alt={ false }      {/* An alternate variation of the component */}
  small={ false }    {/* The small variation of the component */}
  dark={ false }     {/* The dark variation of the component */}
/>

<AUcheckbox
  label="The label"  {/* The label of the checkbox */}
  alt={ false }      {/* An alternate variation of the component */}
  small={ false }    {/* The small variation of the component */}
  dark={ false }     {/* The dark variation of the component */}
/>

(💡 additional props are spread onto the component)

For more details have a look at the usage example.

⬆ back to top

---

Dependency graph

control-input
└─ core

⬆ back to top

---

Tests

The visual test: https://uikit.service.gov.au/packages/control-input/tests/site/

⬆ back to top

---

Release History

• v2.2.0 - Add checkbox list and radiobox list components
• v2.1.6 - Update dependencies
• v2.1.5 - Removing web pack dev server, updating dependencies
• v2.1.4 - Fixed build scripts for Windows
• v2.1.3 - Replace node-sass with sass
• v2.1.2 - Change npm run watch browser-sync location
• v2.1.1 - Update dependencies
• v2.1.0 - Adjust spacing, size and lineheight and fixed errors
• v2.0.3 - Change homepage link
• v2.0.2 - Adding focus offset back to control inputs
• 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.1 - Fixed webkit render bug
• v0.1.0 - 💥 Initial version

⬆ back to top

---

License

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

⬆ back to top

};