Module: alfresco/layout/SlideOverlay

alfresco/layout/SlideOverlay

The SlideOverlay layout allows content to be placed in an always visible container where some additional overlaid content can be animated to slide in over the top of it. An example might be where you select an item in the main content and you want a configuration overlay to appear. When defining the widget model to be processed simply set an attribute of "align" to "overlay" for it to be placed in the overlay container and everything else will be placed in the main (or underlay) container.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

adjustHeightEvents :string[]

This should be configured to be an array of Strings where each string represents a custom event (e.g. one that is triggered by calling the .emit() function) that will trigger the overall height to be updated. that
Type:
  • string[]
Default Value:
  • null
Source:

adjustHeightTopics :string[]

This should be configured to be an array of Strings where each string represents a topic that when published on will trigger the overall height to be updated. that
Type:
  • string[]
Default Value:
  • null
Source:

cssRequirements :object[]

An array of the CSS files to use with this widget.
Type:
  • object[]
Default Value:
  • [{cssFile:"./css/SlideOverlay.css"}]
Source:

hideEvents :string[]

This should be configured to be an array of Strings where each string represents a custom event (e.g. one that is triggered by calling the .emit() function) that will trigger the overlay to be hidden.
Type:
  • string[]
Default Value:
  • null
Source:

hideTopics :string[]

This should be configured to be an array of Strings where each string represents a topic that when published on will trigger the overlay to be hidden.
Type:
  • string[]
Default Value:
  • null
Source:

overlayHidden :boolean

Used to indicate whether or not the overlay is currently hidden.
Type:
  • boolean
Default Value:
  • true
Source:

showEvents :string[]

This should be configured to be an array of Strings where each string represents a custom event (e.g. one that is triggered by calling the .emit() function) that will trigger the overlay to be displayed. that
Type:
  • string[]
Default Value:
  • null
Source:

showTopics :string[]

This should be configured to be an array of Strings where each string represents a topic that when published on will trigger the overlay to be displayed. that
Type:
  • string[]
Default Value:
  • null
Source:

templateString :string

The HTML template to use for the widget.
Type:
  • string
Source:

Methods

adjustHeight()

Adjusts the height of the overall DOM node (through animation) to be as high as is required. This will either be the height of the overlay or the height of the underlay depending upon which is greater.
Source:

hideOverlay()

Hides the overlay.
Source:

postCreate()

Sets up the subscriptions and event handlers to showing and hiding the overlay and then processes all the configured widets to place them into the correct DOM element (i.e the underlay or the overlay).
Source:

processWidget(rootNode, widgetConfig, index)

Parameters:
Name Type Description
rootNode Element
widgetConfig object
index number
Source:

showOverlay()

This displays the overlay by sliding it in over the main node. By default this will slide to the middle of the main DOM node.
Source: