Improve this doc View source

pfToolbar
directive in module patternfly.toolbars

Description

Standard toolbar component. Includes filtering and view selection capabilities

Usage

as element:
<pf-toolbar
       config="{object}">
</pf-toolbar>

Parameters

ParamTypeDetails
configobject

configuration settings for the toolbar:

  • .filterConfig - (Object) Optional filter config. If undefined, no filtering capabilities are shown. See pfSimpleFilter for filter config options.
  • .sortConfig - (Object) Optional sort config. If undefined, no sort capabilities are shown. See pfSort for sort config options.
  • .viewsConfig - (Object) Optional configuration settings for view type selection
    • .views - (Array) List of available views for selection. See pfViewUtils for standard available views
      • .id - (String) Unique id for the view, used for comparisons
      • .title - (String) Optional title, uses as a tooltip for the view selector
      • .iconClass - (String) Icon class to use for the view selector
    • .onViewSelect - ( function(view) ) Function to call when a view is selected
    • .currentView - the id of the currently selected view
  • .actionsConfig - (Object) Optional configuration settings for toolbar actions
    • .primaryActions - (Array) List of primary actions to display on the toolbar
      • .name - (String) The name of the action, displayed on the button
      • .title - (String) Optional title, used for the tooltip
      • .actionFn - (function(action)) Function to invoke when the action selected
      • .isDisabled - (Boolean) set to true to disable the action
    • .moreActions - (Array) List of secondary actions to display on the toolbar action pulldown menu
      • .name - (String) The name of the action, displayed on the button
      • .title - (String) Optional title, used for the tooltip
      • .actionFn - (function(action)) Function to invoke when the action selected
      • .isDisabled - (Boolean) set to true to disable the action
      • .isSeparator - (Boolean) set to true if this is a placehodler for a separator rather than an action
    • .actionsInclude - (Boolean) set to true if using the actions transclude to add custom action buttons (only available if using Angular 1.5 or later)
  • .isTableView - (Boolean) set to true if toolbar is only being used with a table view and viewsConfig is not defined.

Example

Source







Demo