Action Definitions

Actions are operations that can be performed on table data. There are 3 types of actions: bulk actions, table actions, and row actions.

1. Bulk Actions: Actions that can be performed on multiple selected rows. Selected rows are passed to the action callback, allowing for operations on multiple items at once.
2. Table Actions: Actions that can be performed on the table as a whole. It doesn't have an access to the row data, so it's typically used for operations that affect the entire table, e.g. cleaning the table data.
3. Row Actions: Actions that can be performed on individual rows. These actions are accessible via a per-row menu and receive the row's data in the action callback.

Each action callback returns an ActionHandlerResult object, below you can see its definition:

ActionHandlerResult

Bases: TypedDict

Represents the result of an action handler.

ATTRIBUTE	DESCRIPTION
success	Indicates whether the action was successful. TYPE: bool
error	(Optional) Error message if the action failed. TYPE: NotRequired[str | None]
redirect	(Optional) URL to redirect to after the action. TYPE: NotRequired[str | None]
message	(Optional) Informational message about the action result. TYPE: NotRequired[str | None]

Source code in ckanext/tables/types.py

class ActionHandlerResult(TypedDict):
    """Represents the result of an action handler.

    Attributes:
        success: Indicates whether the action was successful.
        error: (Optional) Error message if the action failed.
        redirect: (Optional) URL to redirect to after the action.
        message: (Optional) Informational message about the action result.
    """

    success: bool
    error: NotRequired[str | None]
    redirect: NotRequired[str | None]
    message: NotRequired[str | None]

---

BulkActionDefinition dataclass

Defines an action that can be performed on multiple rows.

ATTRIBUTE	DESCRIPTION
action	Unique identifier for the action. TYPE: str
label	Display label for the action. TYPE: str
callback	Function to be called when the action is triggered. TYPE: BulkActionHandler
icon	(Optional) Icon class for the action. TYPE: str | None
with_confirmation	(Optional) Whether to show a confirmation dialog before executing the action. Defaults to True, since a bulk action affects every selected row. TYPE: bool

Source code in ckanext/tables/table.py

@dataclass(frozen=True)
class BulkActionDefinition:
    """Defines an action that can be performed on multiple rows.

    Attributes:
        action: Unique identifier for the action.
        label: Display label for the action.
        callback: Function to be called when the action is triggered.
        icon: (Optional) Icon class for the action.
        with_confirmation: (Optional) Whether to show a confirmation dialog before executing the action.
            Defaults to True, since a bulk action affects every selected row.
    """

    action: str
    label: str
    callback: types.BulkActionHandler
    icon: str | None = None
    attrs: dict[str, Any] = dataclass_field(default_factory=dict)
    with_confirmation: bool = True

    def __call__(self, rows: list[types.Row]) -> types.ActionHandlerResult:
        return self.callback(rows)

---

TableActionDefinition dataclass

Defines an action that can be performed on the table itself.

ATTRIBUTE	DESCRIPTION
action	Unique identifier for the action. TYPE: str
label	Display label for the action. TYPE: str
callback	Function to be called when the action is triggered. TYPE: TableActionHandler
icon	(Optional) Icon class for the action. TYPE: str | None
with_confirmation	(Optional) Whether to show a confirmation dialog before executing the action. Defaults to True; set to False for a non-destructive actions. TYPE: bool

Source code in ckanext/tables/table.py

@dataclass(frozen=True)
class TableActionDefinition:
    """Defines an action that can be performed on the table itself.

    Attributes:
        action: Unique identifier for the action.
        label: Display label for the action.
        callback: Function to be called when the action is triggered.
        icon: (Optional) Icon class for the action.
        with_confirmation: (Optional) Whether to show a confirmation dialog before executing the action.
            Defaults to True; set to False for a non-destructive actions.
    """

    action: str
    label: str
    callback: types.TableActionHandler
    icon: str | None = None
    attrs: dict[str, Any] = dataclass_field(default_factory=dict)
    with_confirmation: bool = True

    def __call__(self) -> types.ActionHandlerResult:
        return self.callback()

---

RowActionDefinition dataclass

Defines an action that can be performed on a row.

ATTRIBUTE	DESCRIPTION
action	Unique identifier for the action. TYPE: str
label	Display label for the action. TYPE: str
callback	Function to be called when the action is triggered. TYPE: RowActionHandler
icon	(Optional) Icon class for the action. TYPE: str | None
with_confirmation	(Optional) Whether to show a confirmation dialog before executing the action. TYPE: bool

Source code in ckanext/tables/table.py

@dataclass(frozen=True)
class RowActionDefinition:
    """Defines an action that can be performed on a row.

    Attributes:
        action: Unique identifier for the action.
        label: Display label for the action.
        callback: Function to be called when the action is triggered.
        icon: (Optional) Icon class for the action.
        with_confirmation: (Optional) Whether to show a confirmation dialog before executing the action.
    """

    action: str
    label: str
    callback: types.RowActionHandler
    icon: str | None = None
    attrs: dict[str, Any] = dataclass_field(default_factory=dict)
    with_confirmation: bool = False

    def __call__(self, row: types.Row) -> types.ActionHandlerResult:
        return self.callback(row)