iya-sts
    Preparing search index...

    Draws the console's frame around a page's body.

    A static utility class; it holds no state and takes no dependencies.

    Index
    ACCOUNTS_ID: "sts-account-switch" = 'sts-account-switch'
    ACTIVE_NAV_FOCUS: " tabindex=\"-1\" autofocus" = ' tabindex="-1" autofocus'
    MAX_CRUMB: 44
    NAV_GROUP: "sts-console-nav" = 'sts-console-nav'
    REALM_SWITCH_PATH: "/admin/realm-switch" = '/admin/realm-switch'
    SIGNOUT_PATH: "/admin/signout" = '/admin/signout'
    • Draws the account menu's Switch user group: the browser's other accounts, Sign in with another account, and what a switch keeps.

      Parameters

      • list: any

        GET /authn-api/accounts's answer

      • subject: any

        this tab's subject

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the items as HTML

    • Draws the sentence saying the session belongs to another realm.

      It is empty in practice: a console session is never foreign now.

      Parameters

      • info: any

        the gate state

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the sentence as HTML, or an empty string

    • Draws a page's body inside the console's frame: the sidebar, the head row, the trail, the banners, the body and the foot.

      Parameters

      • shell: any

        the console's shell answer (AdminConsole.shellJson())

      • page: any

        title, active (the path that marks the nav), up (a drill-down's way up, or null), inner (the body), path (the realm-relative path and query the page was asked with) and, optional, openSection (the one sidebar section drawn open, #750)

      Returns string

      the frame and the body, as the document's <body> content

    • Draws the banner saying what the gate makes of this reader.

      It covers the gate off, nobody signed in, the open and bootstrap windows, an unclaimed product console, a closed console and the roles held.

      Parameters

      • shell: any
      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the banner as HTML

    • Lists the pages in a list of section rows, groups flattened at any depth.

      Parameters

      • items: any

        a section's or a group's items

      Returns any[]

      the pages, in sidebar order

    • Draws the console's navigation: the realm chooser and every section.

      A realm administrator sees only the pages of their realm and no chooser. Every section is drawn closed but page.openSection's (#750).

      Parameters

      • shell: any

        the console's shell answer

      • page: any

        the page being drawn: active, up, path and, where the reader opened one, openSection (a section's data-section key)

      • t: any

        the translator

      Returns string

      the <nav> as HTML

    • Draws one row of a section's list: a page, or a group holding pages.

      Parameters

      • item: any

        the row

      • active: any

        the path of the page being drawn

      • up: any

        upTo()'s answer on a drill-down, or nothing

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the <li> as HTML

    • A console page's nav label in the reader's language.

      Parameters

      • t: any

        the translator

      • path: string

        the page's console path

      • english: string

        the server's label

      Returns string

      the label, as text

    • Draws one page's nav entry.

      The active page is plain text, or a link back up on a drill-down.

      Parameters

      • item: any

        the page's NAV row

      • active: any

        the path of the page being drawn

      • up: any

        upTo()'s answer on a drill-down, or nothing

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the <li> as HTML

    • Draws the banner shown while the console's gate is off.

      Parameters

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the banner as HTML

    • Draws the trust realm switcher, a GET form to the realm switch route.

      Parameters

      • shell: any
      • page: any
      • t: any

      Returns string

      the form as HTML; empty when no realm is defined

    • Returns where Refresh points: this page without notice and error.

      Parameters

      • path: any

      Returns string

      the root-relative path and query, without the realm prefix

    • Draws the Refresh link at the top of a page.

      Parameters

      • shell: any
      • page: any
      • Optionalt: any

      Returns string

      the link as HTML; empty when the gate is on and nobody is signed in

    • Draws the line every console page of a realm being removed carries, linking to the realm's own page.

      Parameters

      • shell: any
      • Optionalt: any

      Returns string

      the banner as HTML, or an empty string when the realm is not being removed or no realm registry answers

    • Draws the footer line of runtime facts.

      A realm administrator sees only the mode.

      Parameters

      • shell: any
      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the line as HTML; empty when the gate is on and nobody is signed in

    • The sidebar section that holds a page, by its data-section key.

      Parameters

      • sections: any

        the shell answer's sections

      • active: string

        the path of the page being drawn

      Returns string

      that section's key, or '' when the page is in none

    • Lists every page in one section, in sidebar order, groups flattened.

      Parameters

      • section: any

        a row of SECTIONS

      Returns any[]

      the section's pages

    • A section's or a group's title in the reader's language.

      Parameters

      • t: any

        the translator

      • kind: string

        section or group

      • english: string

        the server's title

      Returns string

      the title, as text

    • Shortens a crumb's text to MAX_CRUMB characters with an ellipsis.

      Parameters

      • text: any

        the crumb's text

      Returns string

      the text, cut if it was longer

    • Draws the sidebar: the realm being shown and the navigation.

      Parameters

      • shell: any
      • page: any
      • t: any

      Returns string

      the <aside> as HTML; empty when the gate is on and nobody is signed in

    • Draws the Sign out button, a POST form to the console's sign-out path.

      Parameters

      • gate: any

        the gate state

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the form as HTML; empty when there is no session

    • The key part a console path or a title is looked up by: /admin/xacml/ policies is xacml-policies, /admin is home, Cert issuance is cert-issuance.

      Parameters

      • text: string

        a console path or a title

      Returns string

      the slug

    • Draws the breadcrumb trail from Admin console to the current page.

      On a drill-down the section crumb goes back to the filter and page the reader came from. The last crumb is never a link.

      Parameters

      • active: any

        the path of the page being drawn, or empty

      • up: any

        upTo()'s answer on a drill-down, or nothing

      • title: any

        the page's title, used where the page has no NAV row

      • labels: any

        every console page's nav label by path (the shell answer's navLabels)

      • Optionalt: any

        optional; the translator, the default when left out

      Returns string

      the trail as HTML

    • Draws the account menu: the reader's portal link and Sign out.

      It is a <details>, so it needs no script.

      Parameters

      • shell: any
      • Optionalt: any
      • Optionalpage: any

      Returns string

      the menu as HTML; empty when there is no session

    • Adds tooltips to headings and labels from the prose beside them.

      A heading takes the first note after it, a label the nearest note above it. An element that already has a title is left as it was.

      Parameters

      • inner: any

        the page body as HTML

      Returns string

      the body with the tooltips added