Interface IListRowAction<RowData, Payload>

Represents a row action for a list row.

interface IListRowAction<
    RowData extends IRowData = IAnything,
    Payload extends IAnything = IAnything,
> {
    action?: string;
    divider?: boolean;
    enabled?: boolean;
    icon?: any;
    isDisabled?: (row: RowData, payload: Payload) => boolean | Promise<boolean>;
    isVisible?: (row: RowData, payload: Payload) => boolean | Promise<boolean>;
    label?: string;
    primary?: number | boolean;
}

Type Parameters

Hierarchy

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

Properties

action? divider? enabled? icon? isDisabled? isVisible? label? primary?

Properties

Optionalaction

action?: string

Optionaldivider

divider?: boolean

Optionalenabled

enabled?: boolean

Optionalicon

icon?: any

OptionalisDisabled

isDisabled?: (row: RowData, payload: Payload) => boolean | Promise<boolean>

Checks if a row is disabled based on the row data and payload.

Type declaration

    • (row: RowData, payload: Payload): boolean | Promise<boolean>

    • Parameters

      • row: RowData

        The row data to check.

      • payload: Payload

        The payload to use for checking.

      Returns boolean | Promise<boolean>

      • A Promise or boolean indicating if the row is disabled.

OptionalisVisible

isVisible?: (row: RowData, payload: Payload) => boolean | Promise<boolean>

Determines the visibility of a row based on the provided row data and payload.

Type declaration

    • (row: RowData, payload: Payload): boolean | Promise<boolean>

    • Parameters

      • row: RowData

        The data for the row being evaluated.

      • payload: Payload

        Additional information or data that can be used to determine the row's visibility.

      Returns boolean | Promise<boolean>

      • A boolean value indicating whether the row should be visible or not.

Async

Optionallabel

label?: string

Optionalprimary

primary?: number | boolean

Settings

Member Visibility

On This Page

Properties