Interface IListOperation<RowData, Payload>

Represents an operation that can be performed on a list of row data.

interface IListOperation<
    RowData extends IRowData = IAnything,
    Payload extends IAnything = IAnything,
> {
    action?: string;
    divider?: boolean;
    icon?: any;
    isAvailable?:
        | boolean
        | (
            rowIds: RowData[],
            isAll: boolean,
            payload: Payload,
        ) => boolean | Promise<boolean>;
    label?: string;
    primary?: number | boolean;
}

Type Parameters

Hierarchy

  • Omit<IOption, keyof { isDisabled: never; isVisible: never }>
    • IListOperation

Properties

action? divider? icon? isAvailable? label? primary?

Properties

Optionalaction

action?: string

Optionaldivider

divider?: boolean

Optionalicon

icon?: any

OptionalisAvailable

isAvailable?:
    | boolean
    | (
        rowIds: RowData[],
        isAll: boolean,
        payload: Payload,
    ) => boolean | Promise<boolean>

Determines if the 'isAvailable' variable is a function or a boolean.

Param: rowIds

Array of row identifiers.

Param: isAll

Indicates if all rows are considered.

Param: payload

Additional payload data.

Returns

  • A boolean value or a promise resolving to a boolean indicating availability.

Optionallabel

label?: string

Optionalprimary

primary?: number | boolean

Settings

Member Visibility

On This Page

Properties