Control input

v4.0.0

Control inputs help users input one or more selections from multiple options. Our control inputs consist of checkboxes and radio buttons.

Released

History
View changes
Install
npm i @gold.au/control-input
Tags
Requires
Contributors
  • Trevor Brennan avatar picture
  • Dominik Wilkowski avatar picture
  • Julian Fleetwood avatar picture
  • Alex Page avatar picture
  • Simon Pascal Klein avatar picture
  • Patrick De Young avatar picture
  • Alexander Sadleir avatar picture
  • Gary Broadbent avatar picture
  • Hannah J. Nicdao avatar picture
  • Petra Gulicher avatar picture

React Usage

import { AUcheckbox, AUradio } from '@gold.au/control-input';

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

Props

Radio

Prop name Type Description
label string The label of the radio button
alt boolean An alternate variation of the component
small boolean The small variation of the component
dark boolean A dark variation of the component

All other props are spread into the component

Checkbox

Prop name Type Description
label string The label of the checkbox button
alt boolean An alternate variation of the component
small boolean The small variation of the component
dark boolean A dark variation of the component

All other props are spread into the component

Exports

Name Type Description
AUcheckbox named The checkbox component
AUradio named The radio component

node_modules import

import { Checkbox, Radio } from '@gold.au/control-input';

pancake import

import { Checkbox, Radio } from './control-input';