Class HelpBrowserPF

An Application displaying documentation for the Pathfinder 1e system within Foundry.

Hierarchy

  • Application<ApplicationOptions, this>
    • HelpBrowserPF

Constructors

constructor

Properties

#converter _backwardHistory _currentPage _forwardHistory DEFAULT_OPTIONS PARTS _currentPage

Accessors

currentUrl defaultExtensions

Methods

_onRender _prepareContext _render getCurrentHistoryObject openUrl _backInHistory _forwardInHistory _home

Constructors

constructor

Properties

Private #converter

#converter: Converter

The Markdown converter for this application.

Private _backwardHistory

_backwardHistory: HistoryEntry[] = []

Private _currentPage

_currentPage: HistoryEntry = ...

The currently shown entry.

Private _forwardHistory

_forwardHistory: HistoryEntry[] = []

Static DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        back: (() => void);
        forward: (() => void);
        home: (() => void);
    };
    classes: string[];
    id: string;
    position: {
        height: number;
        width: number;
    };
    window: {
        minimizable: boolean;
        resizable: boolean;
        title: string;
    };
} = ...

Type declaration

  • actions: {
        back: (() => void);
        forward: (() => void);
        home: (() => void);
    }
    • back: (() => void)
        • (): void

        • Go back one page in history.

          Returns void

    • forward: (() => void)
        • (): void

        • Go forward one page in history.

          Returns void

    • home: (() => void)
        • (): void

        • Returns void

  • classes: string[]
  • id: string
  • position: {
        height: number;
        width: number;
    }
    • height: number
    • width: number
  • window: {
        minimizable: boolean;
        resizable: boolean;
        title: string;
    }
    • minimizable: boolean
    • resizable: boolean
    • title: string

Static PARTS

PARTS: {
    form: {
        template: string;
    };
} = ...

Type declaration

  • form: {
        template: string;
    }
    • template: string

Static _currentPage

_currentPage: any

Accessors

currentUrl

Static defaultExtensions

Methods

Protected _onRender

  • _onRender(context, options): void
  • Protected

    Attach event listeners to the rendered application form.

    Parameters

    • context: ApplicationRenderContext

      Prepared context data

    • options: RenderOptions

      Provided render options

    Returns void

_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, options): Promise<void>

  • Parameters

    • force: any
    • options: any

    Returns Promise<void>

    Inherit Doc

getCurrentHistoryObject

openUrl

Static _backInHistory

Static _forwardInHistory

Static _home

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc