KC's Workspace
    Preparing search index...

    Class PageEvent<Model>

    An event emitted by the Renderer class before and after the markup of a page is rendered.

    Type Parameters

    Index

    Constructors

    constructor

    Properties

    contents? filename model pageHeadings pageKind pageSections project url

    Methods

    isReflectionEvent startNewSection

    Events

    BEGIN END

    Constructors

    Properties

    contents?: string

    The final html content of this page.

    Should be rendered by layout templates and can be modified by plugins.

    filename: string

    The filename the page will be written to.

    model: Model

    The model that should be rendered on this page.

    pageHeadings: PageHeading[]

    Links to content within this page that should be rendered in the page navigation. This is built when rendering the document content.

    pageKind: PageKind

    The type of page this is.

    pageSections: { headings: PageHeading[]; title: string }[]

    Sections of the page, generally set by @groups

    project: ProjectReflection

    The project the renderer is currently processing.

    url: string

    The url this page will be located at.

    Methods

    • Start a new section of the page. Sections are collapsible within the "On This Page" sidebar.

      Parameters

      • title: string

      Returns void

    Events

    BEGIN: "beginPage"

    Triggered before a document will be rendered.

    END: "endPage"

    Triggered after a document has been rendered, just before it is written to disc.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    Events