Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class ChangeLog

    Changelog Dialog

    Hierarchy

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
      • ChangeLog
    Index

    Constructors

    constructor

    Properties

    lastVersion tabGroups DEFAULT_OPTIONS PARTS

    Accessors

    title

    Methods

    _configureRenderOptions _loadCache _preparePartContext _processChangelog changeTab _toggleGroup _toggleUpdateDisplay

    Constructors

    • Changelog dialog constructor.

      Parameters

      • options: RenderOptions = {}

        Options for the changelog dialog.

        • lastVersion

          If true, the dialog will only show the last version of the changelog.

      Returns ChangeLog

    Properties

    lastVersion: RenderOptions
    tabGroups: { versions: null } = ...

    If this Application uses tabbed navigation groups, this mapping is updated whenever the changeTab method is called. Reports the active tab for each group, with a value of null indicating no tab is active. Subclasses may override this property to define default tabs for each group.

    DEFAULT_OPTIONS: {
        actions: {
            toggleGroup: (event: Event, button: HTMLElement) => void;
            toggleUpdateDisplay: (_event: Event) => Promise<void>;
        };
        classes: string[];
        id: string;
        position: { height: number; width: number };
        window: { icon: string; minimizable: boolean; resizable: boolean };
    } = ...
    PARTS: {
        footer: { template: string };
        main: { template: string };
        sidebar: { template: string };
    } = ...

    Accessors

    • get title(): string

      Get the title of the changelog dialog.

      Returns string

      • The title of the changelog dialog.

    Methods

    _configureRenderOptions

    • _configureRenderOptions(options: any): void

      Configure the rendering options for the changelog dialog.

      Parameters

      • options: any

        The options to configure.

      Returns void

    _loadCache

    • _loadCache(): Promise<void>
      Internal

      Load the changelog content cache.

      Returns Promise<void>

      • A promise that resolves when the cache is loaded.

    _preparePartContext

    • _preparePartContext(
          partId: any,
      ): Promise<
          {
              activeVersion: any;
              content: any;
              dontShowAgain: SettingInitializedType<"core", KeyFor<"core">>;
              error: null | object;
              link: InitializedType<OptionalString>;
              releaseDate: any;
              versions: IteratorObject<
                  { active: boolean; major: any; minors: any },
                  undefined,
                  unknown,
              >;
          },
      >
      Internal

      Parameters

      • partId: any

        The part identifier to prepare context for

      Returns Promise<
          {
              activeVersion: any;
              content: any;
              dontShowAgain: SettingInitializedType<"core", KeyFor<"core">>;
              error: null | object;
              link: InitializedType<OptionalString>;
              releaseDate: any;
              versions: IteratorObject<
                  { active: boolean; major: any; minors: any },
                  undefined,
                  unknown,
              >;
          },
      >

    _processChangelog

    • _processChangelog(md: string): Map<string, { content: string; version: string }>
      Internal

      Process the raw markdown content of the changelog.

      Parameters

      • md: string

        The raw markdown content of the changelog.

      Returns Map<string, { content: string; version: string }>

      • The cached changelog, with versions as keys and their content as values.

    • Parameters

      • tab: any
      • group: any
      • options: any

      Returns void

    Static_toggleGroup

    • _toggleGroup(event: Event, button: HTMLElement): void

      Toggle the visibility of a version group in the changelog.

      Parameters

      • event: Event

        The event that triggered the action.

      • button: HTMLElement

        The button that was clicked to toggle the group.

      Returns void

    Static_toggleUpdateDisplay

    • _toggleUpdateDisplay(_event: Event): Promise<void>

      Toggle the display of the update notification in the changelog.

      Parameters

      • _event: Event

        The event that triggered the action.

      Returns Promise<void>

      • A promise that resolves when the setting is updated.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods