Interface ISearchModalProps<FilterData, RowData, Payload, Field>

Represents the properties for the Search Modal component.

interface ISearchModalProps<
    FilterData extends {} = IAnything,
    RowData extends IRowData = IAnything,
    Payload extends IAnything = IAnything,
    Field extends IField = IField<FilterData, Payload>,
> {
    actions?: IListAction<RowData, Payload>[];
    actionSubject?: TSubject<string>;
    AfterActionList?: any;
    AfterChips?: any;
    AfterOperationList?: any;
    AfterTitle?: any;
    apiRef?: any;
    BeforeActionList?: any;
    BeforeOperationList?: any;
    BeforeSelectionLabel?: any;
    BeforeTitle?: any;
    chipData?: Partial<Record<keyof RowData, boolean>>;
    chips?: IListChip<RowData>[];
    className?: string;
    columns: IColumn<FilterData, RowData, Payload>[];
    customTemplate?: any;
    customTemplateMinHeight?: number;
    data?: RowId[];
    denseHeight?: number;
    fallback?: (e: Error) => void;
    features?:
        | string[]
        | Record<string, Value>
        | () => string[] | Record<string, Value>;
    fetchDebounce?: number;
    filterData?: Partial<FilterData>;
    filterLabel?: string;
    filters?: Field[];
    fullScreen?: boolean;
    handler: ListHandler<FilterData, RowData>;
    hidden?: boolean;
    incomingTransform?: (data: any, payload: any) => FilterData;
    isBaseline?: (field: IField) => boolean;
    isBaselineForRoot?: (field: IField) => boolean;
    isChooser?: boolean;
    isCustom?: boolean;
    isDense?: boolean;
    isInfinite?: boolean;
    isPageItem?: boolean;
    isRowDisabled?: (
        row: RowData,
        params: {
            chips: Partial<Record<keyof RowData, boolean>>;
            filterData: FilterData;
            pagination: ListHandlerPagination;
            payload: Payload;
            search: string;
            sortModel: ListHandlerSortModel<RowData>;
        },
    ) => boolean;
    itemSx?: any;
    labelDisplayedRows?: (
        paginationInfo: {
            count: number;
            from: number;
            page: number;
            to: number;
        },
    ) => string;
    limit?: number;
    modalSizeRequest?: (
        size: ISize,
    ) => { height: number; sx?: any; width: number };
    noDisplayedRows?: boolean;
    onAction?: (
        action: string,
        selectedRows: RowData[],
        reload: (keepPagination?: boolean) => Promise<void>,
    ) => void;
    onChange?: (data: null | RowId[], initial: boolean) => void;
    onChipsChange?: (data: Partial<Record<keyof RowData, boolean>>) => void;
    onClose?: () => void;
    onColumnAction?: (
        field: string,
        action: string,
        selectedRows: RowData[],
        reload: (keepPagination?: boolean) => Promise<void>,
    ) => void;
    onFilterChange?: (data: FilterData) => void;
    onLimitChange?: (limit: number) => void;
    onLoadEnd?: (isOk: boolean) => void;
    onLoadStart?: () => void;
    onOperation?: (
        action: string,
        selectedRows: RowData[],
        isAll: boolean,
        reload: (keepPagination?: boolean) => Promise<void>,
    ) => void;
    onPageChange?: (page: number) => void;
    onRowAction?: (
        action: string,
        row: RowData,
        reload: (keepPagination?: boolean) => Promise<void>,
    ) => void;
    onRows?: (rows: RowData[]) => void;
    onSearchChange?: (search: string) => void;
    onSortModelChange?: (sort: ListHandlerSortModel<RowData>) => void;
    onSubmit?: (
        data: null | RowId[],
        payload: Payload,
    ) => boolean | Promise<boolean>;
    openSubject: TBehaviorSubject<boolean>;
    operations?: IListOperation<RowData, Payload>[];
    outgoingTransform?: (data: any, payload: any) => FilterData;
    page?: number;
    pageItemTemplate?: any;
    pageItemTemplateMinHeight?: number;
    payload?: Payload | () => Payload;
    readTransform?: (
        value: string | string[],
        name: string,
        data: FilterData,
        payload: any,
    ) => Value;
    reloadSubject?: TSubject<void>;
    rerenderSubject?: TSubject<void>;
    rowActions?: IListRowAction<any, any>[];
    rowColor?: (row: RowData) => string | (row: RowData) => Promise<string>;
    rowMark?: (row: RowData) => string | (row: RowData) => Promise<string>;
    rowsPerPage?: (number | { label: string; value: number })[];
    search?: string;
    selectionLabel?: (size: number) => string | Promise<string>;
    selectionMode?: SelectionMode;
    setFilterDataSubject?: TSubject<FilterData>;
    setLimitSubject?: TSubject<number>;
    setPageSubject?: TSubject<number>;
    setRowsSubject?: TSubject<RowData[]>;
    sizeByElement?: boolean;
    sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number };
    slots?: Partial<ISlotFactoryContext>;
    sortModel?: ListHandlerSortModel<RowData>;
    style?: any;
    submitIcon?: any;
    submitLabel?: string;
    throwError?: boolean;
    tileMode?: TileMode;
    title?: string;
    withAllListOperations?: boolean;
    withArrowPagination?: boolean;
    withHideIfEmpty?: boolean;
    withInitialLoader?: boolean;
    withLoader?: boolean;
    withMobile?: boolean;
    withOutlinePaper?: boolean;
    withRangePagination?: boolean;
    withRawSearch?: boolean;
    withRestorePos?: boolean;
    withSearch?: boolean;
    withSelectOnRowClick?: boolean;
    withSingleChip?: boolean;
    withSingleSort?: boolean;
    withToggledFilters?: boolean;
    withTransparentPaper?: boolean;
    writeTransform?: (
        value: string | string[],
        name: string,
        data: FilterData,
        payload: any,
    ) => Value;
}

Type Parameters

Hierarchy

  • Omit<
        IListProps<FilterData, RowData, Payload, Field>,
        keyof {
            heightRequest: never;
            onLoadEnd: never;
            onLoadStart: never;
            onRowClick: never;
            onSelectedRows: never;
            selectedRows: never;
            widthRequest: never;
        },
    >
    • ISearchModalProps

Properties

actions? actionSubject? AfterActionList? AfterChips? AfterOperationList? AfterTitle? apiRef? BeforeActionList? BeforeOperationList? BeforeSelectionLabel? BeforeTitle? chipData? chips? className? columns customTemplate? customTemplateMinHeight? data? denseHeight? fallback? features? fetchDebounce? filterData? filterLabel? filters? fullScreen? handler hidden? incomingTransform? isBaseline? isBaselineForRoot? isChooser? isCustom? isDense? isInfinite? isPageItem? isRowDisabled? itemSx? labelDisplayedRows? limit? modalSizeRequest? noDisplayedRows? onAction? onChange? onChipsChange? onClose? onColumnAction? onFilterChange? onLimitChange? onLoadEnd? onLoadStart? onOperation? onPageChange? onRowAction? onRows? onSearchChange? onSortModelChange? onSubmit? openSubject operations? outgoingTransform? page? pageItemTemplate? pageItemTemplateMinHeight? payload? readTransform? reloadSubject? rerenderSubject? rowActions? rowColor? rowMark? rowsPerPage? search? selectionLabel? selectionMode? setFilterDataSubject? setLimitSubject? setPageSubject? setRowsSubject? sizeByElement? sizeRequest? slots? sortModel? style? submitIcon? submitLabel? throwError? tileMode? title? withAllListOperations? withArrowPagination? withHideIfEmpty? withInitialLoader? withLoader? withMobile? withOutlinePaper? withRangePagination? withRawSearch? withRestorePos? withSearch? withSelectOnRowClick? withSingleChip? withSingleSort? withToggledFilters? withTransparentPaper? writeTransform?

Properties

Optionalactions

actions?: IListAction<RowData, Payload>[]

OptionalactionSubject

actionSubject?: TSubject<string>

Subject for trigger action externally

OptionalAfterActionList

AfterActionList?: any

Represents a React component for AfterActionList.

Typeparam

FilterData - The type of filter data.

Typeparam

RowData - The type of row data.

Typeparam

Payload - The type of payload.

OptionalAfterChips

AfterChips?: any

Represents a React component that will be rendered after the chip list.

OptionalAfterOperationList

AfterOperationList?: any

Represents the AfterOperationList component.

This component is a React component that renders a list of actions to be displayed after a specific operation. It is used to render the list of available actions, typically used for filtering or manipulating data.

Template: FilterData

The type of data used for filtering.

Template: RowData

The type of data associated with each row.

Template: Payload

The type of payload used for each action.

Component

OptionalAfterTitle

AfterTitle?: any

OptionalapiRef

apiRef?: any

OptionalBeforeActionList

BeforeActionList?: any

Represents a React component type for BeforeActionList.

Template: FilterData

The type of data used for filtering.

Template: RowData

The type of data used for individual rows.

Template: Payload

The type of payload for action.

OptionalBeforeOperationList

BeforeOperationList?: any

A React component that represents a list of position actions before an operation.

Template: FilterData

The type of data used for filtering the list

Template: RowData

The type of data used for each row in the list

Template: Payload

The type of data sent as a payload during an operation

OptionalBeforeSelectionLabel

BeforeSelectionLabel?: any

Represents a React component type for BeforeSelectionLabel.

Template: FilterData

The type of data used for filtering.

Template: RowData

The type of data used for individual rows.

Template: Payload

The type of payload for action.

OptionalBeforeTitle

BeforeTitle?: any

OptionalchipData

chipData?: Partial<Record<keyof RowData, boolean>>

Optionalchips

chips?: IListChip<RowData>[]

OptionalclassName

className?: string

columns

columns: IColumn<FilterData, RowData, Payload>[]

OptionalcustomTemplate

customTemplate?: any

Represents a custom template component for rendering a tile.

Template: -

The type of data for the tile row.

Template: -

The type of payload associated with the tile.

OptionalcustomTemplateMinHeight

customTemplateMinHeight?: number

Represents the minimum height for a custom template.

Optionaldata

data?: RowId[]

OptionaldenseHeight

denseHeight?: number

Represents the height of an element, measured in pixels.

Optionalfallback

fallback?: (e: Error) => void

Optionalfeatures

features?:
    | string[]
    | Record<string, Value>
    | () => string[] | Record<string, Value>

OptionalfetchDebounce

fetchDebounce?: number

Represents the debounce time in milliseconds for performing fetch requests.

OptionalfilterData

filterData?: Partial<FilterData>

OptionalfilterLabel

filterLabel?: string

Optionalfilters

filters?: Field[]

OptionalfullScreen

fullScreen?: boolean

handler

handler: ListHandler<FilterData, RowData>

Optionalhidden

hidden?: boolean

OptionalincomingTransform

incomingTransform?: (data: any, payload: any) => FilterData

OptionalisBaseline

isBaseline?: (field: IField) => boolean

OptionalisBaselineForRoot

isBaselineForRoot?: (field: IField) => boolean

OptionalisChooser

isChooser?: boolean

OptionalisCustom

isCustom?: boolean

OptionalisDense

isDense?: boolean

OptionalisInfinite

isInfinite?: boolean

OptionalisPageItem

isPageItem?: boolean

OptionalisRowDisabled

isRowDisabled?: (
    row: RowData,
    params: {
        chips: Partial<Record<keyof RowData, boolean>>;
        filterData: FilterData;
        pagination: ListHandlerPagination;
        payload: Payload;
        search: string;
        sortModel: ListHandlerSortModel<RowData>;
    },
) => boolean

Determines if a row is disabled based on various parameters.

Type declaration

OptionalitemSx

itemSx?: any

OptionallabelDisplayedRows

labelDisplayedRows?: (
    paginationInfo: {
        count: number;
        from: number;
        page: number;
        to: number;
    },
) => string

Returns a string containing information about the displayed rows label.

Type declaration

    • (
          paginationInfo: {
              count: number;
              from: number;
              page: number;
              to: number;
          },
      ): string

    • Parameters

      • paginationInfo: { count: number; from: number; page: number; to: number }

        An object containing pagination information.

        • count: number

          The total count of rows.

        • from: number

          The starting index of the displayed rows.

        • page: number

          The current page.

        • to: number

          The ending index of the displayed rows.

      Returns string

      • The label displaying information about the displayed rows.

Optionallimit

limit?: number

OptionalmodalSizeRequest

modalSizeRequest?: (size: ISize) => { height: number; sx?: any; width: number }

Custom sizeRequest for modal filters

OptionalnoDisplayedRows

noDisplayedRows?: boolean

OptionalonAction

onAction?: (
    action: string,
    selectedRows: RowData[],
    reload: (keepPagination?: boolean) => Promise<void>,
) => void

OptionalonChange

onChange?: (data: null | RowId[], initial: boolean) => void

OptionalonChipsChange

onChipsChange?: (data: Partial<Record<keyof RowData, boolean>>) => void

OptionalonClose

onClose?: () => void

OptionalonColumnAction

onColumnAction?: (
    field: string,
    action: string,
    selectedRows: RowData[],
    reload: (keepPagination?: boolean) => Promise<void>,
) => void

OptionalonFilterChange

onFilterChange?: (data: FilterData) => void

OptionalonLimitChange

onLimitChange?: (limit: number) => void

OptionalonLoadEnd

onLoadEnd?: (isOk: boolean) => void

OptionalonLoadStart

onLoadStart?: () => void

OptionalonOperation

onOperation?: (
    action: string,
    selectedRows: RowData[],
    isAll: boolean,
    reload: (keepPagination?: boolean) => Promise<void>,
) => void

OptionalonPageChange

onPageChange?: (page: number) => void

OptionalonRowAction

onRowAction?: (
    action: string,
    row: RowData,
    reload: (keepPagination?: boolean) => Promise<void>,
) => void

OptionalonRows

onRows?: (rows: RowData[]) => void

OptionalonSearchChange

onSearchChange?: (search: string) => void

OptionalonSortModelChange

onSortModelChange?: (sort: ListHandlerSortModel<RowData>) => void

OptionalonSubmit

onSubmit?: (
    data: null | RowId[],
    payload: Payload,
) => boolean | Promise<boolean>

openSubject

openSubject: TBehaviorSubject<boolean>

Optionaloperations

operations?: IListOperation<RowData, Payload>[]

OptionaloutgoingTransform

outgoingTransform?: (data: any, payload: any) => FilterData

Optionalpage

page?: number

OptionalpageItemTemplate

pageItemTemplate?: any

Represents a custom template component for rendering a tile.

Template: -

The type of data for the tile row.

Template: -

The type of payload associated with the tile.

OptionalpageItemTemplateMinHeight

pageItemTemplateMinHeight?: number

Represents the minimum height for a page template.

Optionalpayload

payload?: Payload | () => Payload

OptionalreadTransform

readTransform?: (
    value: string | string[],
    name: string,
    data: FilterData,
    payload: any,
) => Value

OptionalreloadSubject

reloadSubject?: TSubject<void>

OptionalrerenderSubject

rerenderSubject?: TSubject<void>

OptionalrowActions

rowActions?: IListRowAction<any, any>[]

OptionalrowColor

rowColor?: (row: RowData) => string | (row: RowData) => Promise<string>

OptionalrowMark

rowMark?: (row: RowData) => string | (row: RowData) => Promise<string>

OptionalrowsPerPage

rowsPerPage?: (number | { label: string; value: number })[]

Optionalsearch

search?: string

OptionalselectionLabel

selectionLabel?: (size: number) => string | Promise<string>

OptionalselectionMode

selectionMode?: SelectionMode

OptionalsetFilterDataSubject

setFilterDataSubject?: TSubject<FilterData>

OptionalsetLimitSubject

setLimitSubject?: TSubject<number>

OptionalsetPageSubject

setPageSubject?: TSubject<number>

OptionalsetRowsSubject

setRowsSubject?: TSubject<RowData[]>

OptionalsizeByElement

sizeByElement?: boolean

OptionalsizeRequest

sizeRequest?: (size: ISize) => { height: number; sx?: any; width: number }

Optionalslots

slots?: Partial<ISlotFactoryContext>

OptionalsortModel

sortModel?: ListHandlerSortModel<RowData>

Optionalstyle

style?: any

OptionalsubmitIcon

submitIcon?: any

OptionalsubmitLabel

submitLabel?: string

OptionalthrowError

throwError?: boolean

OptionaltileMode

tileMode?: TileMode

Tiling mode for custom template

Optionaltitle

title?: string

OptionalwithAllListOperations

withAllListOperations?: boolean

OptionalwithArrowPagination

withArrowPagination?: boolean

OptionalwithHideIfEmpty

withHideIfEmpty?: boolean

OptionalwithInitialLoader

withInitialLoader?: boolean

OptionalwithLoader

withLoader?: boolean

OptionalwithMobile

withMobile?: boolean

OptionalwithOutlinePaper

withOutlinePaper?: boolean

OptionalwithRangePagination

withRangePagination?: boolean

OptionalwithRawSearch

withRawSearch?: boolean

OptionalwithRestorePos

withRestorePos?: boolean

OptionalwithSearch

withSearch?: boolean

OptionalwithSelectOnRowClick

withSelectOnRowClick?: boolean

OptionalwithSingleChip

withSingleChip?: boolean

OptionalwithSingleSort

withSingleSort?: boolean

OptionalwithToggledFilters

withToggledFilters?: boolean

OptionalwithTransparentPaper

withTransparentPaper?: boolean

OptionalwriteTransform

writeTransform?: (
    value: string | string[],
    name: string,
    data: FilterData,
    payload: any,
) => Value

Settings

Member Visibility

On This Page

Properties
actionsactionSubjectAfterActionListAfterChipsAfterOperationListAfterTitleapiRefBeforeActionListBeforeOperationListBeforeSelectionLabelBeforeTitlechipDatachipsclassNamecolumnscustomTemplatecustomTemplateMinHeightdatadenseHeightfallbackfeaturesfetchDebouncefilterDatafilterLabelfiltersfullScreenhandlerhiddenincomingTransformisBaselineisBaselineForRootisChooserisCustomisDenseisInfiniteisPageItemisRowDisableditemSxlabelDisplayedRowslimitmodalSizeRequestnoDisplayedRowsonActiononChangeonChipsChangeonCloseonColumnActiononFilterChangeonLimitChangeonLoadEndonLoadStartonOperationonPageChangeonRowActiononRowsonSearchChangeonSortModelChangeonSubmitopenSubjectoperationsoutgoingTransformpagepageItemTemplatepageItemTemplateMinHeightpayloadreadTransformreloadSubjectrerenderSubjectrowActionsrowColorrowMarkrowsPerPagesearchselectionLabelselectionModesetFilterDataSubjectsetLimitSubjectsetPageSubjectsetRowsSubjectsizeByElementsizeRequestslotssortModelstylesubmitIconsubmitLabelthrowErrortileModetitlewithAllListOperationswithArrowPaginationwithHideIfEmptywithInitialLoaderwithLoaderwithMobilewithOutlinePaperwithRangePaginationwithRawSearchwithRestorePoswithSearchwithSelectOnRowClickwithSingleChipwithSingleSortwithToggledFilterswithTransparentPaperwriteTransform