Interface SearchOperatorBuilder<TType, TValue>`Alpha`

interface SearchOperatorBuilder<TType extends string, TValue> {
    buttonValueComponent?: SearchOperatorButtonValue<TValue>;
    descriptionKey: `search.operator.${Lowercase<string>}.description`;
    groqFilter: (params: SearchOperatorParams<TValue>) => string;
    icon?: ComponentType;
    initialValue: TValue;
    inputComponent: SearchOperatorInput<TValue>;
    nameKey: `search.operator.${Lowercase<string>}.name`;
    type: TType;
}

Type Parameters

TType extends string
TValue

Hierarchy (View Summary)

SearchOperatorBase
- SearchOperatorBuilder

Index

Properties

buttonValueComponent? descriptionKey groqFilter icon? initialValue inputComponent nameKey type

Properties

`Optional` `Alpha`buttonValueComponent

buttonValueComponent?: SearchOperatorButtonValue<TValue>

`Alpha`descriptionKey

descriptionKey: `search.operator.${Lowercase<string>}.description`

i18n resource key for the "name", eg quantity is or contains

`Alpha`groqFilter

groqFilter: (params: SearchOperatorParams<TValue>) => string

`Optional` `Alpha`icon

icon?: ComponentType

icon for explaining the operator (React component)

`Alpha`initialValue

initialValue: TValue

`Alpha`inputComponent

inputComponent: SearchOperatorInput<TValue>

`Alpha`nameKey

nameKey: `search.operator.${Lowercase<string>}.name`

i18n resource key for the "name", eg quantity is or contains

`Alpha`type

type: TType

name/type of operator, eg arrayCountEqual or numberGt