Input
Overview
Text fields allow users to enter text into a UI. They typically appear in forms and dialogs. In this component, a prefix, placeholder text, suffix, trailing icon, and descriptive text can be hidden or revealed depending on what is needed.
Example
Properties
Property | Description | Type | Default | Required |
---|---|---|---|---|
label | The label for the input | string | ✓ | |
hideLabel | Hide the label | boolean | false | |
disabled | Disable the input | boolean | false | |
success | Indicate that something with the field has been successful. Not every field will have this, it should only be used in special situations. | boolean | false | |
name | The name for the input | string | ||
type | The input type. Must be a valid html input type. | string | text | |
descriptiveText | Some additional descriptive text | string | ||
placeholder | The input placeholder | string | ||
error | Displays an error message | string | ||
required | Make the input required | boolean | false | |
pattern | The input pattern | string | ||
readonly | Make the input readonly | boolean | false | |
wrapperClass | Add a class or classes to the input wrapperClass | string | Array | ||
cols | The cols for a textarea | number | 35 | |
rows | The rows for a textarea | number | 4 |