IArbitraryValuesInputProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props for ArbitraryValuesInput component.
export interface IArbitraryValuesInputProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Optional id(s) of elements that describe this control. | ||
string | (ALPHA) (Optional) Optional id of an external label that describes this control. | ||
string[] | (ALPHA) (Optional) Optional list of autocomplete suggestions. When provided, a dropdown of matching options is shown while the user types. Selecting an option adds it as a chip. Already-selected values are excluded from the suggestions. | ||
boolean | (ALPHA) (Optional) Whether the input is disabled | ||
string | (ALPHA) Localized display string for empty value (e.g. “(empty value)”). Used for parsing input and displaying empty string values. | ||
boolean | (ALPHA) (Optional) Whether empty-value validation should be shown. | ||
boolean | (ALPHA) (Optional) True when value limit exceeded (error state) - red border on container. | ||
boolean | (ALPHA) (Optional) True when at value limit (warning state) - yellow border on container. | ||
string | (ALPHA) (Optional) Optional id of the values input. | ||
boolean | (ALPHA) (Optional) Whether autocomplete is currently loading results from the backend. | ||
(searchString: string) => void | (ALPHA) (Optional) Optional callback to trigger a search for autocomplete suggestions. When provided, this will be called as the user types to fetch matching elements from the backend. | ||
FocusEventHandler<HTMLInputElement> | (ALPHA) (Optional) Callback when input loses focus. | ||
(values: Array<string | null>) => void | (ALPHA) (Optional) Callback when values change | ||
string | (ALPHA) (Optional) Placeholder text | ||
Array<string | null> | (ALPHA) Current values |
Property details
IArbitraryValuesInputProps.ariaDescribedBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional id(s) of elements that describe this control.
ariaDescribedBy?: string;
IArbitraryValuesInputProps.ariaLabelledBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional id of an external label that describes this control.
ariaLabelledBy?: string;
IArbitraryValuesInputProps.autocompleteOptionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional list of autocomplete suggestions. When provided, a dropdown of matching options is shown while the user types. Selecting an option adds it as a chip. Already-selected values are excluded from the suggestions.
autocompleteOptions?: string[];
IArbitraryValuesInputProps.disabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the input is disabled
disabled?: boolean;
IArbitraryValuesInputProps.emptyValueDisplaypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Localized display string for empty value (e.g. “(empty value)”). Used for parsing input and displaying empty string values.
emptyValueDisplay: string;
IArbitraryValuesInputProps.hasEmptyErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether empty-value validation should be shown.
hasEmptyError?: boolean;
IArbitraryValuesInputProps.hasValuesLimitExceededErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
True when value limit exceeded (error state) - red border on container.
hasValuesLimitExceededError?: boolean;
IArbitraryValuesInputProps.hasValuesLimitReachedWarningpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
True when at value limit (warning state) - yellow border on container.
hasValuesLimitReachedWarning?: boolean;
IArbitraryValuesInputProps.inputIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional id of the values input.
inputId?: string;
IArbitraryValuesInputProps.isAutocompleteLoadingpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether autocomplete is currently loading results from the backend.
isAutocompleteLoading?: boolean;
IArbitraryValuesInputProps.onAutocompleteSearchpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional callback to trigger a search for autocomplete suggestions. When provided, this will be called as the user types to fetch matching elements from the backend.
onAutocompleteSearch?: (searchString: string) => void;
IArbitraryValuesInputProps.onBlurpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when input loses focus.
onBlur?: FocusEventHandler<HTMLInputElement>;
IArbitraryValuesInputProps.onValuesChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when values change
onValuesChange?: (values: Array<string | null>) => void;
IArbitraryValuesInputProps.placeholderpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Placeholder text
placeholder?: string;
IArbitraryValuesInputProps.valuespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current values
values: Array<string | null>;