Function useSearchModal

The useSearchModal function is a custom hook that provides functionality for displaying a search modal. It accepts various parameters and returns an object with properties and methods for controlling the search modal.

  • useSearchModal<FilterData, RowData, Payload, Field>(__namedParameters): {
        close: (() => Promise<boolean>);
        open: boolean;
        pickData: ((param?: Param) => void);
        render: (() => Element);
    }

  • Type Parameters

    • FilterData extends {} = any

      The type of the filter data.

    • RowData extends IRowData = any

      The type of the row data.

    • Payload extends unknown = any

      The type of the payload.

    • Field extends IField<any, any, Field> = IField<FilterData, Payload>

      The type of the field.

    Parameters

    Returns {
        close: (() => Promise<boolean>);
        open: boolean;
        pickData: ((param?: Param) => void);
        render: (() => Element);
    }

    An object with properties and methods for controlling the search modal.

    • Readonlyclose: (() => Promise<boolean>)
        • (): Promise<boolean>

        • Returns Promise<boolean>

    • open: boolean
    • pickData: ((param?: Param) => void)
        • (param?): void

        • Parameters

          • param: Param = []

          Returns void

    • render: (() => Element)
        • (): Element

        • Returns Element

Settings

Member Visibility