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 extends {} = any,
        RowData extends IRowData = any,
        Payload extends unknown = any,
        Field extends IField<any, any> = IField<FilterData, Payload>,
    >(
        __namedParameters: IParams<FilterData, RowData, Payload, Field>,
    ): {
        close: () => Promise<boolean>;
        open: (
            url?: string | URL,
            target?: string,
            features?: string,
        ) => null | Window;
        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> = IField<FilterData, Payload>

      The type of the field.

    Parameters

    Returns {
        close: () => Promise<boolean>;
        open: (
            url?: string | URL,
            target?: string,
            features?: string,
        ) => null | Window;
        pickData: (param?: Param) => void;
        render: () => Element;
    }

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

    • Readonlyclose: () => Promise<boolean>
    • Readonlyopen: (url?: string | URL, target?: string, features?: string) => null | Window
    • ReadonlypickData: (param?: Param) => void
    • Readonlyrender: () => Element

Settings

Member Visibility