Module: alfresco/header/Title

alfresco/header/Title

This widget can be used to render a title for a page in a large font. It will also set the title of the browser window when setBrowserTitle is configured to be true. It subscribes to the "ALF_UPDATE_PAGE_TITLE" topic in order support the requests to dynamically re-render the title with a new value.
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

_originalLabel :string

This is an internal variable used to preserve a copy of the original browser window title to be used when updated are made by publication.
Type:
  • string
Since:
  • 1.0.73
Default Value:
  • null
Source:

browserTitlePrefix :string

This is the prefix to apply before the label when setting the browser window title. It defaults to a standard Alfresco prefix but should be overridden if required. The browser title will only be set when setBrowserTitle is set to true.
Type:
  • string
Default Value:
  • "Alfresco"
Source:

cssRequirements :object[]

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

label :string

Type:
  • string
Default Value:
  • null
Source:

setBrowserTitle :boolean

Indicates whether or not the browser window title should be updated
Type:
  • boolean
Default Value:
  • false
Source:

targetUrl :string

This is the URL to navigate to when the title is clicked.
Type:
  • string
Default Value:
  • null
Source:

targetUrlType :string

Indicates how the target URL should be handled.
Type:
  • string
Since:
  • 1.0.32
Default Value:
Source:

templateString :String

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

Methods

getAnchorTargetSelectors()

Returns an array containing the selector that identifies the span to wrap in an anchor. This overrides the mixed in function that just returns an empty array.
Since:
  • 1.0.32
Source:

onClick(evt)

Handles click events when a targetUrl has been provided.
Parameters:
Name Type Description
evt object The click event
Since:
  • 1.0.32
Source:

postCreate()

Source:
Listens to Events:

postMixInProperties()

It's important to perform label encoding before buildRendering occurs (e.g. before postCreate) to ensure that an unencoded label isn't set and then replaced.
Source:

updatePageTitle(payload)

Handles requests to update the page title.
Parameters:
Name Type Description
payload object The payload published on the update title topic
Source: