InlineField API
API reference docs for theInlineFieldcomponent. For examples and details on the usage of this component, visit the component demo page.
Props
| Prop | Type | Description | Default |
|---|---|---|---|
children | ReactNode | The <TextInput />, <Textarea /> component to be displayed inside the inline field. | _ |
errorMessage? | ReactNode | Message to show when the field is invalid. Will be announced to screen readers and displayed with error styling. | _ |
id? | string | Sets a unique identifier for the component. Useful for form accessibility and testing. | _ |
isDisabled? | boolean | When true, the field is disabled, preventing user interaction and applying disabled styling. | false |
isRequired? | boolean | Whether user input is required on the field before form submission. Adds visual indication and accessibility attributes. | false |
label | ReactNode | Label for the field that describes its purpose. Required for accessibility. | _ |
labelVisibility? | 'visible' | 'hidden' | A label must always be provided for assistive technology, but you may hide it from sighted users when the intent can be inferred from context. | 'visible' |
secondaryLabel? | ReactNode | Additional context displayed alongside the primary label, typically used to indicate that the field is optional. | _ |
counter? | object | Counter object containing maxValue and value properties. "maxValue": maximum value the counter can reach. "value": current value of the counter. Used to display character count information. | _ |