Interface TableActionResolverContext

An object of this kind lives only for the time a concrete UI is displayed. It provides a way to react to action state changes, e.g. when an action is hidden or deactivated. Additionally, it provides a way to conditionally render row actions.

interface TableActionResolverContext {
    destroy(): void;
    getBulkActions(dataTable): TableActionItem<BulkButtonTableAction>[];
    getRowActions(dataTable, rowItem): TableActionItem<RowButtonTableAction>[];
    on<Name>(eventName, callback): EventHandle;
    on(eventName, callback): EventHandle;
    on(eventName, callback): EventHandle;
}

Hierarchy

Methods

destroy getBulkActions getRowActions on

Methods

destroy

  • destroy(): void

  • Must be called by a UI to indicate that the context is no longer required.

    Returns void

getBulkActions

getRowActions

on

  • on<Name>(eventName, callback): EventHandle

  • Register event listener for specific events.

    Type Parameters

    Parameters

    Returns EventHandle

    a handle to unregister from the event

  • on(eventName, callback): EventHandle

  • Register event listener for any event.

    Parameters

    • eventName: "*"

      must be "*" for this overload

    • callback: EventCallback<void>

      the event handler callback will be invoked when any event has been emitted

    Returns EventHandle

    a handle to unregister from the events

  • on(eventName, callback): EventHandle

  • Register event listener for the events listed in eventName. Comma separated event names are possible, for example "eventA,eventB".

    Parameters

    • eventName: string | string[]

      the event name or list of names

    • callback: EventCallback<unknown>

      the event handler callback

    Returns EventHandle

    a handle to unregister from the event(s)

Settings

Member Visibility

Theme

On This Page

destroygetBulkActionsgetRowActionson

Generated using TypeDoc