Class ChangeLogWindow

Changelog Dialog

Hierarchy

  • any
    • ChangeLogWindow

Constructors

constructor

Properties

_cache autoDisplay lastVersion DEFAULT_OPTIONS PARTS

Accessors

title

Methods

_prepareContext _processChangelog _updateObject

Constructors

constructor

  • Parameters

    • lastVersion: boolean = false

      Display only latest version, legacy versions are to be omitted.

    • autoDisplay: boolean = false

      Is the dialog being shown without prompting?

    Returns ChangeLogWindow

Properties

_cache

_cache: any

autoDisplay

autoDisplay: boolean

lastVersion

lastVersion: boolean

Static DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    classes: string[];
    form: {
        closeOnSubmit: boolean;
        handler: ((event, form, formData) => Promise<void>);
        submitOnChange: boolean;
    };
    id: string;
    position: {
        height: number;
        width: number;
    };
    tag: string;
    window: {
        minimizable: boolean;
        resizable: boolean;
    };
} = ...

Type declaration

  • classes: string[]
  • form: {
        closeOnSubmit: boolean;
        handler: ((event, form, formData) => Promise<void>);
        submitOnChange: boolean;
    }
    • closeOnSubmit: boolean
    • handler: ((event, form, formData) => Promise<void>)
        • (event, form, formData): Promise<void>
        • Internal

          Cancel distribution and close dialog

          Parameters

          • event: SubmitEvent

            The originating form submission event

          • form: HTMLFormElement

            The form element that was submitted

          • formData: FormDataExtended

            Processed data for the submitted form

          Returns Promise<void>

          Static

    • submitOnChange: boolean
  • id: string
  • position: {
        height: number;
        width: number;
    }
    • height: number
    • width: number
  • tag: string
  • window: {
        minimizable: boolean;
        resizable: boolean;
    }
    • minimizable: boolean
    • resizable: boolean

Static PARTS

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

Type declaration

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

Accessors

title

Methods

_prepareContext

  • _prepareContext(): Promise<{
        autoDisplay: boolean;
        changelog: any;
        dontShowAgain: unknown;
        lastVersion: boolean;
        link: any;
    }>
  • Internal

    Returns Promise<{
        autoDisplay: boolean;
        changelog: any;
        dontShowAgain: unknown;
        lastVersion: boolean;
        link: any;
    }>

    Inherit Doc

    Async

_processChangelog

Static _updateObject

  • _updateObject(event, form, formData): Promise<void>
  • Internal

    Cancel distribution and close dialog

    Parameters

    • event: SubmitEvent

      The originating form submission event

    • form: HTMLFormElement

      The form element that was submitted

    • formData: FormDataExtended

      Processed data for the submitted form

    Returns Promise<void>

    Static

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc