In this example, the setTitle method is used to generate a title for the page. The title is visible in the top-left corner of the page, just above the rendered extension.
Captured on UUX version 4.6.0.10A.
setTitle
- Updated:
Supported Platforms:
UUX
Config
Sets the title displayed in association with the outlet your module is rendered into.
The setTitle function takes a single string argument which is displayed in association with the outlet your module is rendered into. Generally the title string will be displayed in the platform above your rendered module, but it is ultimately up to the platform's design.
Details
Type
tecton.actions.setTitle(title: string): void;
Example
Module should call setTitle immediately after connect, and any time the content shown changes in a way necessitating a title change.
This allows sub routing within modules while showing titles for pages in a unified way across a platform.
This is also useful for accessibility purposes because it creates/updates a <title> tag accessible to screen readers in the <head> of the current document.
Calling setTitle with an empty string will remove the displayed title.
tecton.actions.setTitle('Home');Example
- UUX
Arguments
UUX
Config
Content populated by the platform as title associated with your module
Release Notes
Initial Release