Documentation - v19.12.0-dev
    Preparing search index...

    Interface TeiaSearchFilterEditorProps

    Props of the TeiaSearchFilterEditor.

    interface TeiaSearchFilterEditorProps {
        className?: string;
        defaultFilter?: TeiaSearchFilter;
        defaultGroupOperator?: "And" | "Or";
        enableAI?: boolean;
        enableJsonEditor?: boolean;
        id?: string;
        name?: string;
        onChange?: (value: TeiaSearchFilter, isValid: boolean) => void;
        showErrors?: boolean;
        twin?: Twin;
    }
    Index

    Properties

    className? defaultFilter? defaultGroupOperator? enableAI? enableJsonEditor? id? name? onChange? showErrors? twin?

    Properties

    className?: string

    Class name of the element

    defaultFilter?: TeiaSearchFilter

    Default value of the filter editor

    {}
    defaultGroupOperator?: "And" | "Or"

    Default group operator for the root group if filter is empty

    'And'
    enableAI?: boolean

    Shows a button opening a prompt generating the filter from a description in natural language. It requires the twin and the Tia API url of the Teia plugin (settings.api.tiaApiUrl).

    false
    enableJsonEditor?: boolean

    Shows a button opening the filter in a JSON editor, to copy, download or edit it.

    false
    id?: string

    Id of the element

    name?: string

    Name of the element

    onChange?: (value: TeiaSearchFilter, isValid: boolean) => void

    Callback when the filter changes.

    Type Declaration

      • (value: TeiaSearchFilter, isValid: boolean): void

      • Parameters

        • value: TeiaSearchFilter

          The new filter of the filter

        • isValid: boolean

          Indicates whether the filter is valid.

        Returns void

    showErrors?: boolean

    Should the editor show the errors

    twin?: Twin

    Twin to get autocompletion (you have to set the token and the baseUrl to use this)

    Settings

    Member Visibility

    On This Page

    Properties