Class HelpBrowserPF

constructor

• new HelpBrowserPF(options?: {}): HelpBrowserPF

• Parameters

  • options: {} = {}

  Returns HelpBrowserPF

  Inherit Doc

Static_currentPage

StaticDEFAULT_OPTIONS

StaticPARTS

currentUrl

• get currentUrl(): string

• The URL of the page currently displayed

  Returns string

StaticdefaultExtensions

• get defaultExtensions(): ShowdownExtension[]

• Extensions for the Markdown converter used by the help browser.

  Returns ShowdownExtension[]

_prepareContext

• _prepareContext(): Promise<
      {
          hasHistoryBack: boolean;
          hasHistoryForward: boolean;
          pageContent: any;
          url: string;
      },
  >
• Internal

  Returns Promise<
      {
          hasHistoryBack: boolean;
          hasHistoryForward: boolean;
          pageContent: any;
          url: string;
      },
  >

  Inherit Doc

  Async

_render

• _render(force: any, options: any): Promise<void>

• Parameters

  • force: any
  • options: any

  Returns Promise<void>

  Inherit Doc

getCurrentHistoryObject

• getCurrentHistoryObject(): HistoryEntry

• Returns a HistoryEntry containing a snapshot of the currently rendered state.

  Returns HistoryEntry

  The current state

openUrl

• openUrl(url: string): void

• Opens a specific page in the help browser.

  Parameters

  • url: string

    The help URL to open

  Returns void

Static_backInHistory

• _backInHistory(): void

• Go back one page in history.

  Returns void

Static_forwardInHistory

• _forwardInHistory(): void

• Go forward one page in history.

  Returns void

Static_home

• _home(): void

• Returns void