module:core/bulkactions/bulk_actions

module:core/bulkactions/bulk_actions

new (require("core/bulkactions/bulk_actions"))() → {void}

Description:

  • The class constructor.

Source:
Returns:
Type
void

Members

initialStickyFooterContent

Source:
Properties:
Name Type Description
initialStickyFooterContent string | null

The initial content of the sticky footer.

isBulkActionsModeEnabled

Source:
Properties:
Name Type Description
isBulkActionsModeEnabled boolean

Whether the bulk actions mode is enabled.

selectedItems

Source:
Properties:
Name Type Description
selectedItems Array

The array of selected item elements.

(inner, constant) The :Object

Description:

  • object containing the relevant selectors.

Source:

object containing the relevant selectors.

Type:
  • Object

Methods

(inner) disableBulkActionsMode() → {void}

Description:

  • Disables the bulk action mode.

Source:
Returns:
Type
void

(inner) enableBulkActionsMode() → {Promise}

Description:

  • Enables the bulk action mode.

Source:
Returns:
Type
Promise

(inner) getBulkActions() → {Array}

Description:

  • Returns the array of the relevant bulk action objects.

Source:
Returns:
Type
Array

(inner) getSelectedItems() → {Array}

Description:

  • Returns the array of selected items.

Source:
Returns:
Type
Array

(inner) getStickyFooterContainer() → {HTMLElement}

Description:

  • Returns the sticky footer container.

Source:
Returns:
Type
HTMLElement

(inner) registerItemSelectChangeEvent(eventHandler) → {void}

Description:

  • Adds the listener for the item select change event. The event handler function that is passed as a parameter should be called right after the event is triggered.

Source:
Parameters:
Name Type Description
eventHandler function

The event handler function.
Returns:
Type
void

(inner) renderBulkActions() → {Promise}

Description:

  • Renders the bulk actions content.

Source:
Returns:
Type
Promise

(inner) updateBulkItemSelection() → {void}

Description:

  • Updates the selected items count in the bulk actions content.

Source:
Returns:
Type
void