Text inputs
v3.0.0Text inputs are input fields typically used in forms that allow the user to enter text data in a structured format. Text inputs should be accompanied by labels.
Released
- History
- View changes
- Install
- npm i @gold.au/text-inputs
- Tags
- Requires
- Contributors
React Usage
import AUtextInput from '@gold.au/text-inputs';
<label htmlFor="name" >Your name?</label>
<AUtextInput id="name" block />
Props
Prop name | Type | Description |
---|---|---|
as | string | The kind of input, can be either 'input' or 'textarea', default: 'input' |
block | string | Add the block variation class |
number | string | Add the number styling class |
status | number | Mark this field as either 'valid' or 'invalid' |
dark | boolean | A dark variation of the component |
width | string | Width of text input, can be either xs , sm , md , lg or xl |
All other props are spread into the component
Exports
Name | Type | Description |
---|---|---|
AUtextInput |
default | The textInput component |
node_modules import
import AUtextInput from '@gov.au/text-input';
pancake import
import AUtextInput from './text-input';