Text input
This component allows users to enter free-form text.
import { ... } from '@ag.ds-next/react/text-input';Usage
Text input components can be imported via the text-input entrypoint in the @ag.ds-next/react package.
For example:
import { ... } from '@ag.ds-next/react/text-input';Props
| Prop | Type | Description |
|---|---|---|
| label | string | Describes the purpose of the field. |
| autoComplete? | string | |
| autoFocus? | boolean | |
| block? | boolean | If true, the field will stretch to the fill the width of its container. |
| disabled? | boolean | |
| hideOptionalLabel? | boolean | If true, "(optional)" will never be appended to the label. |
| hint? | string | Provides extra information about the field. |
| id? | string | |
| inputMode? | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | |
| invalid? | boolean | If true, the invalid state will be rendered. |
| maxLength? | number | |
| maxWidth? | "xs" | "sm" | "md" | "lg" | "xl"Default: "md" | The maximum width of the field. |
| message? | string | Message to show when the field is invalid. |
| name? | string | |
| onBlur? | FocusEventHandler<HTMLInputElement> | |
| onChange? | ChangeEventHandler<HTMLInputElement> | |
| onFocus? | FocusEventHandler<HTMLInputElement> | |
| pattern? | string | |
| placeholder? | string | |
| ref? | Ref<HTMLInputElement> | |
| required? | boolean | If false, "(optional)" will be appended to the label. |
| type? | HTMLInputTypeAttributeDefault: "text" | |
| value? | string | number | readonly string[] |
Source
You can view the full source code for this package on Github.