Overview
Input Text is a form entry component, where users can enter a customized text or string.
Input Text can limit the number of characters with its max and min properties.
Usage
- Text or string submissions in forms
Sample
Accessibility
Keyboard navigation
| Key | Function |
|---|---|
Tab | Moves focus in and out of the component. |
Tab and Shift | Moves focus in and out of the component. |
Esc | When clearable is true, clears the component's value. |
API reference
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
| alignment | alignment | Specifies the text alignment of the component's value. | "center" | "end" | "start" | "start" |
| autocomplete | Specifies the type of content to autocomplete, for use in forms. Read the native attribute's documentation on MDN for more info. | AutoFill | ||
| clearable | clearable | When true, a clear button is displayed when the component has a value. | boolean | false |
| disabled | disabled | When true, interaction is prevented and the component is displayed with lower opacity. | boolean | false |
| form | form | The id of the form that will be associated with the component.
When not set, the component will be associated with its ancestor form element, if any. | string | |
| icon | icon | Specifies an icon to display. | boolean | string | |
| iconFlipRtl | icon-flip-rtl | When true, the icon will be flipped when the element direction is right-to-left ("rtl"). | boolean | false |
| label | label | Accessible name for the component's button or hyperlink. | string | |
| labelText | label-text | string | ||
| loading | loading | When true, the component is in the loading state and calcite-progress is displayed. | boolean | false |
| maxLength | max-length | When the component resides in a form, specifies the maximum length of text for the component's value. | number | |
| messageOverrides | Use this property to override individual strings used by the component. | Record<string, unknown> | ||
| minLength | min-length | When the component resides in a form, specifies the minimum length of text for the component's value. | number | |
| name | name | Specifies the name of the component.
Required to pass the component's value on form submission. | string | |
| pattern | pattern | When the component resides in a form,
specifies a regular expression (regex) pattern the component's value must match for validation.
Read the native attribute's documentation on MDN for more info. | string | |
| placeholder | placeholder | Specifies placeholder text for the component. | string | |
| prefixText | prefix-text | Adds text to the start of the component. | string | |
| readOnly | read-only | When true, the component's value can be read, but cannot be modified. | boolean | false |
| required | required | When true and the component resides in a form,
the component must have a value in order for the form to submit. | boolean | false |
| scale | scale | Specifies the size of the component. | "l" | "m" | "s" | "m" |
| status | status | Specifies the status of the input field, which determines message and icons. | "idle" | "invalid" | "valid" | "idle" |
| suffixText | suffix-text | Adds text to the end of the component. | string | |
| validationIcon | validation-icon | Specifies the validation icon to display under the component. | boolean | string | |
| validationMessage | validation-message | Specifies the validation message to display under the component. | string | |
| validity | The current validation state of the component. | {
valid: boolean;
badInput: boolean;
customError: boolean;
patternMismatch: boolean;
rangeOverflow: boolean;
rangeUnderflow: boolean;
stepMismatch: boolean;
tooLong: boolean;
tooShort: boolean;
typeMismatch: boolean;
valueMissing: boolean;
} | ||
| value | value | The component's value. | string |
Slots
| Name | Description |
|---|---|
| action | A slot for positioning a button next to the component. |
| label-content | A slot for rendering content next to the component's labelText. |
Styles
| Name | Description |
|---|---|
| --calcite-input-action-background-color | Specifies the background color of the component's clearable element. |
| --calcite-input-action-background-color-hover | Specifies the background color of the component's clearable element when hovered. |
| --calcite-input-action-background-color-press | Specifies the background color of the component's clearable element when pressed. |
| --calcite-input-action-icon-color | Specifies the icon color of the component's clearable & icon elements. |
| --calcite-input-action-icon-color-hover | Specifies the icon color of the component's clearable & icon elements when hovered. |
| --calcite-input-action-icon-color-press | Specifies the icon color of the component's clearable & icon elements when pressed. |
| --calcite-input-loading-background-color | Specifies the background color of the loading element. |
| --calcite-input-loading-fill-color | Specifies the fill color of the loading element. |
| --calcite-input-prefix-background-color | When prefixText is provided, specifies the background color of the component's prefix element. |
| --calcite-input-prefix-size-x | When prefixText is provided, specifies the width of the component's prefix element. |
| --calcite-input-prefix-text-color | When prefixText is provided, specifies the text color of the component's prefix element. |
| --calcite-input-suffix-background-color | When suffixText is provided, specifies the background color of the component's suffix element. |
| --calcite-input-suffix-size-x | When suffixText is provided, specifies the width of the component's suffix element. |
| --calcite-input-suffix-text-color | When suffixText is provided, specifies the color of the component's suffix element. |
| --calcite-input-text-background-color | Specifies the component's background color. |
| --calcite-input-text-border-color | Specifies the component's border color. |
| --calcite-input-text-corner-radius | Specifies the component's border radius. |
| --calcite-input-text-icon-color | Specifies the component's icon color. |
| --calcite-input-text-placeholder-text-color | Specifies the component's placeholder text color. |
| --calcite-input-text-text-color | Specifies the component's text color. |
| --calcite-input-text-text-color-focus | Specifies the component's text color when focused. |
Events
| Name | Description | Behavior |
|---|---|---|
| calciteInputTextChange | Fires each time a new value is typed and committed. | |
| calciteInputTextInput | Fires each time a new value is typed. |
Methods
| Name | Description | Signature |
|---|---|---|
| componentOnReady | Create a promise that resolves once component is fully loaded. | componentOnReady(): Promise<void> |
| selectText | Selects the text of the component's value. | selectText(): Promise<void> |
| setFocus | Sets focus on the component. | setFocus(options?: FocusOptions): Promise<void> |