Namespace: componentBrowser

Granite.author.ui. componentBrowser

The component browser provides the ability to browse the allowed components that could be dropped into the current page. It is located in the SidePanel

See Granite.author.components for the Component Store.

Source:
ui/ui.componentBrowser.js

Members


<static> $el :jQuery

Corresponding jQuery element

Type:
  • jQuery
Source:
ui/ui.componentBrowser.js

Methods


<static> filterComponents(options)

Filters the components to be displayed in the card view, and sets the dropdown list of allowed groups of components

Parameters:
Name Type Argument Description
options Object <optional>

Configuration object

Properties
Name Type Argument Description
keepItems boolean <optional>

Should the existing items be kept

clearFilter boolean <optional>

Should the the search filter field be cleared

Source:
ui/ui.componentBrowser.js

<static> handleFilterComponents(event)

Handles the filtering of the components:

  • Keeps the items when not switching tabs
  • Clears the filter when switching tabs
Parameters:
Name Type Description
event Object

Source event

Source:
ui/ui.componentBrowser.js

<static> tabIsActive()

Is the components tab visible and active

Source:
ui/ui.componentBrowser.js
Returns:
Type
boolean