core/bulkactions/bulk_action

Description:

  • Base class for defining a bulk action.

Source:
Copyright:
  • 2023 Mihail Geshoski
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Base class for defining a bulk action.

Members

selectedItems

Source:
Properties:
Name Type Description
selectedItems array

The array of selected item elements.

Methods

(inner) getBulkActionTriggerSelector() → {string}

Description:

  • Defines the selector of the element that triggers the bulk action.

Source:
Returns:
Type
string

(inner) registerListenerEvents(containerElement) → {void}

Description:

  • Registers the listener events for the bulk actions.

Source:
Parameters:
Name Type Description
containerElement HTMLElement

The container element for the bulk actions.
Returns:
Type
void

(inner) renderBulkActionTrigger(showInDropdown, index) → {Promise}

Description:

  • Renders the bulk action trigger element.

Source:
Parameters:
Name Type Description
showInDropdown boolean

Whether the action is displayed under a 'More' dropdown or as a separate button.
index number

The index of the action.
Returns:
Type
Promise

(inner) setSelectedItems(selectedItems) → {void}

Description:

  • Setter method for the selectedItems property.

Source:
Parameters:
Name Type Description
selectedItems Array

The array of selected item elements..
Returns:
Type
void

(inner) triggerBulkAction()

Description:

  • Defines the behavior once the bulk action is triggered.

Source: