Input Message provides a contextual message to a user allowing the passing of content, links, etc.
Note
When the component is empty, the
hidden property/attribute should be used to hide the component from the DOM, otherwise additional spacing will be displayed.Overview
Input Message is a utility component, which can provide context or helpful hints to an accompanying component, such as an Input.
Usage
- Error message handling for a form-based component
- Additional messaging to an accompanying component
Sample
API reference
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
| icon | icon | Specifies an icon to display. | IconName | boolean | |
| iconFlipRtl | icon-flip-rtl | When true and the element direction is right-to-left ("rtl"), flips the components icon`. | boolean | false |
| scale | scale | Specifies the size of the component. | Scale | "m" |
| status | status | Specifies the input field's status, which determines message and icons. | Status | "idle" |
Slots
| Name | Description |
|---|---|
| default (unnamed) | A slot for adding text. |
Styles
| Name | Description |
|---|---|
| --calcite-input-message-spacing-value | --calcite-input-message-spacing. Specifies the margin spacing at the top of the component. |
| --calcite-input-message-spacing | Specifies the component's top margin spacing. |
| --calcite-input-message-icon-color | Specifies the component's icon color. |
Methods
| Name | Description | Signature |
|---|---|---|
| componentOnReady | Create a promise that resolves once component is fully loaded. | componentOnReady(): Promise<this> |