Module: alfresco/html/Heading

alfresco/html/Heading

Author:
  • Richard Smith
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Example

Sample configuration

{
   name: "alfresco/html/Heading",
   config: {
      level: 2, // This will produce an <h2> element
      label: "Headings are good for screen readers", // This could be a fixed label or an i18m msg call
      isHidden: true // This heading is hidden accessibly
   }
}

Extends

Mixes In

Members

_hiddenAccessibleClass :string

Class to use when isHidden = true
Type:
  • string
Default Value:
  • "hiddenAccessible"
Source:

additionalCssClasses :string

Any additional css classes to add.
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/Heading.css"}]
Source:

headingId :String

The optional id to assign to the generated heading
Type:
  • String
Default Value:
  • null
Source:

isHidden :Boolean

Should the heading be hidden (accessibly)?
Type:
  • Boolean
Default Value:
  • false
Source:

label :String

The heading text to display
Type:
  • String
Source:

level :number

The level of heading to generate
Type:
  • number
Default Value:
  • 1
Source:

templateString :String

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

Methods

onHeadingUpdate(payload)

Parameters:
Name Type Description
payload object The details of the label update
Source:

postCreate()

Source:

postMixInProperties()

Source: