Axinom Mosaic Libraries
    Preparing search index...

    Interface ExplorerBulkAction<T>

    interface ExplorerBulkAction<T extends Data> {
        actionType?: PageHeaderActionType;
        className?: string;
        confirmationConfig?: ConfirmationConfig;
        confirmationMode?: ConfirmationMode;
        disabled?: boolean;
        icon?: string | IconName;
        imgAlt?: string;
        label: string;
        onClick: (
            arg?: ItemSelection<T>,
        ) => void | ErrorType | Promise<(void | ErrorType)>;
        openInNewTab?: undefined;
        path?: undefined;
        reloadData?: boolean;
        showStartedNotification?: boolean;
        tag?: string;
    }

    Type Parameters

    Hierarchy

    Index

    Properties

    actionType? className? confirmationConfig? confirmationMode? disabled? icon? imgAlt? label onClick openInNewTab? path? reloadData? showStartedNotification? tag?

    Properties

    actionType?: PageHeaderActionType

    Whether the action is an 'Active' or 'Context' type. Changes the background color to the corresponding action type. (default: 'Context')

    className?: string

    Optional class

    confirmationConfig?: ConfirmationConfig

    Optional text overrides for the confirmation pop up.

    confirmationMode?: ConfirmationMode

    If set to 'Simple', the action will require confirmation. If set to 'Advanced', action will require confirmation via a confirmation pop up. (default: 'None')

    disabled?: boolean

    Whether the action is disabled. If set to true, disallows interactions. (default: undefined)

    icon?: string | IconName

    Optional built in icon. This prop also accepts an img src.

    imgAlt?: string

    Optional image alt attribute.

    label: string

    The label of the action.

    onClick: (
        arg?: ItemSelection<T>,
    ) => void | ErrorType | Promise<(void | ErrorType)>

    Callback to emit when a user clicks on the component

    Type Declaration

    openInNewTab?: undefined

    If set to true, the link will open in a new tab.

    path?: undefined

    Where to navigate to when the action is clicked.

    reloadData?: boolean

    Whether the Explorer should reload the data once the bulk action is completed

    showStartedNotification?: boolean

    Whether or not to show toast notification once the bulk action is started (shown by default)

    tag?: string

    Optional tag to display in the action

    Settings

    Member Visibility

    On This Page

    Properties