Class HelpBrowserPF

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

Hierarchy

Application<ApplicationOptions, this>
- HelpBrowserPF

Index

Constructors

constructor

new HelpBrowserPF(options?: {}): HelpBrowserPF
Parameters
- options: {} = {}
Returns HelpBrowserPF
Inherit Doc
Overrides HandlebarsApplicationMixin(ApplicationV2).constructor
- Defined in module/applications/help-browser.mjs:63

Properties

`Static`_currentPage

_currentPage: any

`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 };
} = ...

`Static`PARTS

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

Accessors

currentUrl

get currentUrl(): string
The URL of the page currently displayed

Returns string
- Defined in module/applications/help-browser.mjs:81

`Static`defaultExtensions

get defaultExtensions(): ShowdownExtension[]
Extensions for the Markdown converter used by the help browser.

Returns ShowdownExtension[]
- Defined in module/applications/help-browser.mjs:226

Methods

`Protected`_onRender

_onRender(context: ApplicationRenderContext, options: RenderOptions): void
Protected
Attach event listeners to the rendered application form.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: RenderOptions
  Provided render options
Returns void
- Defined in module/applications/help-browser.mjs:197

_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
- Defined in module/applications/help-browser.mjs:92

_render

_render(force: any, options: any): Promise<void>
Parameters
- force: any
- options: any
Returns Promise<void>
Inherit Doc
Overrides HandlebarsApplicationMixin(ApplicationV2)._render
- Defined in module/applications/help-browser.mjs:127

getCurrentHistoryObject

getCurrentHistoryObject(): HistoryEntry
Returns a HistoryEntry containing a snapshot of the currently rendered state.

Returns HistoryEntry
The current state
- Defined in module/applications/help-browser.mjs:153

openUrl

openUrl(url: string): void
Opens a specific page in the help browser.
Parameters
- url: string
  The help URL to open
Returns void
- Defined in module/applications/help-browser.mjs:109

`Static`_backInHistory

_backInHistory(): void
Go back one page in history.

Returns void
- Defined in module/applications/help-browser.mjs:165

`Static`_forwardInHistory

_forwardInHistory(): void
Go forward one page in history.

Returns void
- Defined in module/applications/help-browser.mjs:175

`Static`_home

_home(): void
Returns void
- Defined in module/applications/help-browser.mjs:184

Class HelpBrowserPF

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns HelpBrowserPF

Inherit Doc

Properties

Static_currentPage

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

currentUrl

Returns string

StaticdefaultExtensions

Returns ShowdownExtension[]

Methods

Protected_onRender

Parameters

Returns void

_prepareContext

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

Inherit Doc

Async

_render

Parameters

Returns Promise<void>

Inherit Doc

getCurrentHistoryObject

Returns HistoryEntry

openUrl

Parameters

Returns void

Static_backInHistory

Returns void

Static_forwardInHistory

Returns void

Static_home

Returns void

Settings

On This Page

`Static`_currentPage

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Static`defaultExtensions

`Protected`_onRender

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

`Static`_backInHistory

`Static`_forwardInHistory

`Static`_home