Class SidebarComponentTemplateProcessor

This class is responsible for the extraction of collection capabilities and their conversion into a format suitable for sidebar navigation rendering. Finally, this class provides a method to populate and render the sidebar UI component template.

Hierarchy (View Summary)

Constructors

constructor

Properties

_filePath _templatePath _templateRenderer

Methods

getTemplatePageTitle processTemplate

Constructors

constructor

Properties

Protected Readonly_filePath

_filePath: string

Protected Readonly_templatePath

_templatePath: string

Protected Readonly_templateRenderer

_templateRenderer: TemplateGenerator<SidebarComponentTemplate>

Methods

ProtectedgetTemplatePageTitle

  • getTemplatePageTitle(
        pageTitleLanguageString: undefined | LanguageString,
        languageId?: string,
    ): null | string

  • Retrieves the title of a template page in the specified language.

    Parameters

    • pageTitleLanguageString: undefined | LanguageString

      An object containing language-specific titles.

    • languageId: string = "en"

      The language identifier for the title. Defaults to "en", if not provided.

    Returns null | string

    The page title in the specified language, or the first available language if not found.

processTemplate

  • processTemplate(
        dependencies: SidebarComponentDependencyMap,
    ): Promise<LayerArtifact>

  • Processes and renders the React component template for the sidebar UI component. To generate the component correctly, it uses the list of capabilities to be included within the sidebar.

    Parameters

    • dependencies: SidebarComponentDependencyMap

      Dependencies providing the information about the aggregate and context for the template.

    Returns Promise<LayerArtifact>

    A promise that resolves to the artifact which contains generated React component for the sidebar.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods