@gov.au/control-input

@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
• Build
• 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 { Checkbox, Radio } from './control-input.js';

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

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

All props:

<Radio
	label="The label"      {/* The label of the radio button */}
	name="the_name"        {/* The name attribute */}
	full={ false }         {/* An option for the radio button theme */}
	value="value"          {/* The value attribute */}
	disabled={ false }     {/* The disabled attribute */}
	checked={ false }      {/* The state of the radio button */}
	onChange={ () => {} }  {/* A function to be executed onChange */}
/>

<Checkbox
	label="The label"      {/* The label of the checkbox */}
	name="the_name"        {/* The name attribute */}
	full={ false }         {/* An option for the checkbox theme */}
	disabled={ false }     {/* The disabled attribute */}
	checked={ false }      {/* The state of the checkbox */}
	onChange={ () => {} }  {/* A function to be executed onChange */}
/>

For more details have a look at the usage example.

⬆ back to top

---

Dependency graph

control-input
└─ core

⬆ back to top

---

Build

⬆ back to top

---

Tests

The visual test: http://uikit.apps.staging.digital.gov.au/packages/control-input/tests/site/

⬆ back to top

---

Release History

• 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

};