Module: alfresco/menus/_AlfDisplayFilterMixin

alfresco/menus/_AlfDisplayFilterMixin

This mixin provides display filtering capabilities. It can be mixed into any widget so that if the widget is configured with a filterTopic will be called which by default does nothing. It is up to the inheriting module to override this function to determine whether or not the widget is displayed or hidden.

Type:
  • string
Default Value:
  • null
Source:

Methods

filter(payload)

This does nothing by default and should be overridden by the inheriting module to determine whether or not the widget should be displayed or hidden. The [show]{@link module:alfresco/menus/_AlfDisplayFilterMixin#show} and [hide]{@link module:alfresco/menus/_AlfDisplayFilterMixin#hide} functions should be called to change the widgets display state.
Parameters:
Name Type Description
payload object The payload published on the filter topic
Source:

hide()

Hides the menu item.
Source:

postCreate()

Ensures that the supplied menu item label is translated.
Source:

show()

Displays the menu item.
Source: