ITextFilterBodyProps

Home > @gooddata/sdk-ui-filters > ITextFilterBodyProps

ITextFilterBodyProps interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Props for TextFilterBody component.

Signature:

export interface ITextFilterBodyProps 

Properties

Property	Modifiers	Type	Description
attributeTitle		string	(ALPHA) Attribute title for context
autocompleteOptions?		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.
availableTextModes?		AttributeFilterTextMode[]	(ALPHA) (Optional) Available text sub-modes.
caseSensitive		boolean	(ALPHA) Case sensitive flag for like operators
disabled?		boolean	(ALPHA) (Optional) Whether the filter is disabled
hasLiteralEmptyError?		boolean	(ALPHA) (Optional) True if empty-literal validation should be shown.
hasValuesEmptyError?		boolean	(ALPHA) (Optional) True if empty-values validation should be shown.
hasValuesLimitExceededError?		boolean	(ALPHA) (Optional) True when value limit exceeded (truncated) - error shown, Apply disabled.
hasValuesLimitReachedWarning?		boolean	(ALPHA) (Optional) True when at value limit (values.length === max) - warning shown, Apply enabled.
isAutocompleteLoading?		boolean	(ALPHA) (Optional) Whether autocomplete is currently loading results from the backend.
literal		string	(ALPHA) Literal for like operators (when not using chips)
onAutocompleteSearch?		(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.
onLiteralBlur?		() => void	(ALPHA) (Optional) Callback when literal field loses focus.
onLiteralChange?		(literal: string) => void	(ALPHA) (Optional) Callback when literal changes (for other operators)
onOperatorChange?		(operator: TextFilterOperator) => void	(ALPHA) (Optional) Callback when operator changes
onToggleCaseSensitive?		() => void	(ALPHA) (Optional) Callback to toggle case sensitivity
onValuesBlur?		() => void	(ALPHA) (Optional) Callback when values input loses focus.
onValuesChange?		(values: Array<string | null>) => void	(ALPHA) (Optional) Callback when values change (for is/is not)
operator		TextFilterOperator	(ALPHA) Current operator
values		Array<string | null>	(ALPHA) Current values (chips for is/is not) or literal (single input for others)