ITextFilterBodyProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props for TextFilterBody component.
export interface ITextFilterBodyProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) Attribute title for context | ||
string[] | (ALPHA) (Optional) Autocomplete suggestions for the values input (is / is not operators). Populated from the loaded attribute elements so the user can pick known values. | ||
(ALPHA) (Optional) Available text sub-modes. | |||
boolean | (ALPHA) Case sensitive flag for like operators | ||
boolean | (ALPHA) (Optional) Whether the filter is disabled | ||
boolean | (ALPHA) (Optional) True if empty-literal validation should be shown. | ||
boolean | (ALPHA) (Optional) True if empty-values validation should be shown. | ||
boolean | (ALPHA) (Optional) True when value limit exceeded (truncated) - error shown, Apply disabled. | ||
boolean | (ALPHA) (Optional) True when at value limit (values.length === max) - warning shown, Apply enabled. | ||
boolean | (ALPHA) (Optional) If true, tooltips in the filter body are hidden. | ||
boolean | (ALPHA) (Optional) Whether autocomplete is currently loading results from the backend. | ||
string | (ALPHA) Literal for like operators (when not using chips) | ||
(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. | ||
() => void | (ALPHA) (Optional) Callback when literal field loses focus. | ||
(literal: string) => void | (ALPHA) (Optional) Callback when literal changes (for other operators) | ||
(operator: TextFilterOperator) => void | (ALPHA) (Optional) Callback when operator changes | ||
() => void | (ALPHA) (Optional) Callback to toggle case sensitivity | ||
() => void | (ALPHA) (Optional) Callback when values input loses focus. | ||
(values: Array<string | null>) => void | (ALPHA) (Optional) Callback when values change (for is/is not) | ||
(ALPHA) Current operator | |||
string | (ALPHA) (Optional) Optional id for the validation message element. When provided, inputs and action buttons can reference this id in aria-describedby. | ||
Array<string | null> | (ALPHA) Current values (chips for is/is not) or literal (single input for others) |
Property details
ITextFilterBodyProps.attributeTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Attribute title for context
attributeTitle: string;
ITextFilterBodyProps.autocompleteOptionspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Autocomplete suggestions for the values input (is / is not operators). Populated from the loaded attribute elements so the user can pick known values.
autocompleteOptions?: string[];
ITextFilterBodyProps.availableTextModespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Available text sub-modes.
availableTextModes?: AttributeFilterTextSelectionType[];
ITextFilterBodyProps.caseSensitivepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Case sensitive flag for like operators
caseSensitive: boolean;
ITextFilterBodyProps.disabledpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether the filter is disabled
disabled?: boolean;
ITextFilterBodyProps.hasLiteralEmptyErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
True if empty-literal validation should be shown.
hasLiteralEmptyError?: boolean;
ITextFilterBodyProps.hasValuesEmptyErrorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
True if empty-values validation should be shown.
hasValuesEmptyError?: boolean;
ITextFilterBodyProps.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 (truncated) - error shown, Apply disabled.
hasValuesLimitExceededError?: boolean;
ITextFilterBodyProps.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 (values.length === max) - warning shown, Apply enabled.
hasValuesLimitReachedWarning?: boolean;
ITextFilterBodyProps.hideTooltipspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
If true, tooltips in the filter body are hidden.
hideTooltips?: boolean;
ITextFilterBodyProps.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;
ITextFilterBodyProps.literalpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Literal for like operators (when not using chips)
literal: string;
ITextFilterBodyProps.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;
ITextFilterBodyProps.onLiteralBlurpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when literal field loses focus.
onLiteralBlur?: () => void;
ITextFilterBodyProps.onLiteralChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when literal changes (for other operators)
onLiteralChange?: (literal: string) => void;
ITextFilterBodyProps.onOperatorChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when operator changes
onOperatorChange?: (operator: TextFilterOperator) => void;
ITextFilterBodyProps.onToggleCaseSensitivepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback to toggle case sensitivity
onToggleCaseSensitive?: () => void;
ITextFilterBodyProps.onValuesBlurpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when values input loses focus.
onValuesBlur?: () => void;
ITextFilterBodyProps.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 (for is/is not)
onValuesChange?: (values: Array<string | null>) => void;
ITextFilterBodyProps.operatorpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current operator
operator: TextFilterOperator;
ITextFilterBodyProps.validationMessageIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Optional id for the validation message element. When provided, inputs and action buttons can reference this id in aria-describedby.
validationMessageId?: string;
ITextFilterBodyProps.valuespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current values (chips for is/is not) or literal (single input for others)
values: Array<string | null>;