A compendium of knowledge arcane and mystical! Renders the sidebar directory of compendium packs

Mixes

Hierarchy (view full)

Properties

entryType: string = "Compendium"
_original: SidebarTab

Denote whether this is the original version of the sidebar tab, or a pop-out variant

options: object

The options provided to this application upon initialization

_element: jQuery

An internal reference to the HTML element this application renders

position: object

Track the current position and dimensions of the Application UI

_dragDrop: DragDrop[]

DragDrop workflow handlers which are active for this Application

_tabs: Tabs[]

Tab navigation handlers which are active for this Application

_searchFilters: SearchFilter[]

SearchFilter handlers which are active for this Application

_minimized: boolean

Track whether the Application is currently minimized

_scrollPositions: object

Track the most recent scroll positions for any vertically scrolling containers

appId: number

The application ID is a unique incrementing integer which is used to identify every application window drawn by the VTT

_popout: SidebarTab

A reference to the pop-out variant of this SidebarTab, if one exists

_state: number

The current render state of the Application

See

_priorState: number

The prior render state of this Application. This allows for rendering logic to understand if the application is being rendered for the first time.

See

#activeFilters: string[] = []

A reference to the currently active compendium types. If empty, all types are shown.

entryPartial: string = "templates/sidebar/partials/pack-partial.html"
RENDER_STATES: Readonly<{
    ERROR: -3;
    CLOSING: -2;
    CLOSED: -1;
    NONE: 0;
    RENDERING: 1;
    RENDERED: 2;
}> = ...

The sequence of rendering states that track the Application life-cycle.

Type declaration

  • ERROR: -3
  • CLOSING: -2
  • CLOSED: -1
  • NONE: 0
  • RENDERING: 1
  • RENDERED: 2

Accessors

  • get collection(): any
  • The collection of Compendium Packs which are displayed in this Directory

    Returns any

  • get id(): string
  • Returns string

  • get tabName(): string
  • The base name of this sidebar tab

    Returns string

  • get element(): jQuery
  • Return the active application element, if it currently exists in the DOM

    Returns jQuery

  • get template(): string
  • The path to the HTML template file which should be used to render the inner content of the app

    Returns string

  • get popOut(): boolean
  • Control the rendering style of the application. If popOut is true, the application is rendered in its own wrapper window, otherwise only the inner app content is rendered

    Returns boolean

  • get rendered(): boolean
  • Return a flag for whether the Application instance is currently rendered

    Returns boolean

  • get closing(): boolean
  • Whether the Application is currently closing.

    Returns boolean

  • get title(): string
  • An Application window should define its own title definition logic which may be dynamic depending on its data

    Returns string

  • get defaultOptions(): object
  • Returns object

Methods

  • Parameters

    • entry: any

    Returns any

  • Parameters

    • entryId: any

    Returns {
        type: string;
        id: any;
    }

    • type: string
    • id: any
  • Parameters

    • entry: any
    • otherEntry: any

    Returns boolean

  • Parameters

    • entry: any
    • sortData: any

    Returns Promise<void>

  • Parameters

    • document: any
    • folder: any

    Returns Promise<void>

  • Parameters

    • entry: any

    Returns any

  • Parameters

    • entry: any

    Returns any

  • Parameters

    • options: {} = {}

      Returns Promise<{
          cssId: string;
          cssClass: any;
          tabName: string;
          user: User;
      }>

    • Returns ({
          name: string;
          icon: string;
          callback: ((li) => any);
          condition?: undefined;
      } | {
          name: string;
          icon: string;
          condition: ((header) => boolean);
          callback: ((header) => void);
      })[]

    • Parameters

      • event: any

      Returns Promise<void>

    • Parameters

      • event: any

      Returns Promise<any>

    • Parameters

      • force: boolean = false
      • options: {} = {}

        Returns Promise<void>

      • Parameters

        • data: any

        Returns Promise<jQuery>

      • Activate this SidebarTab, switching focus to it

        Returns void

      • Parameters

        • options: any

        Returns Promise<void>

      • Create a second instance of this SidebarTab class which represents a singleton popped-out container

        Returns SidebarTab

        The popped out sidebar tab instance

      • Render the SidebarTab as a pop-out container

        Returns void

      • Handle lazy loading for sidebar images to only load them once they become observed

        Parameters

        • entries: HTMLElement[]

          The entries which are now observed

        • observer: IntersectionObserver

          The intersection observer instance

        Returns void

      • Change the currently active tab

        Parameters

        • tabName: string

          The target tab name to switch to

        • options: {
              group: string;
              triggerCallback: boolean;
          } = {}

          Options which configure changing the tab

          • group: string

            A specific named tab group, useful if multiple sets of tabs are present

          • triggerCallback: boolean

            Whether to trigger tab-change callback functions

        Returns void

      • Bring the application to the top of the rendering stack

        Returns void

      • Minimize the pop-out window, collapsing it to a small tab Take no action for applications which are not of the pop-out variety or apps which are already minimized

        Returns Promise<void>

        A Promise which resolves once the minimization action has completed

      • Maximize the pop-out window, expanding it to its original size Take no action for applications which are not of the pop-out variety or are already maximized

        Returns Promise<void>

        A Promise which resolves once the maximization action has completed

      • Set the application position and store its new location. Returns the updated position object for the application containing the new values.

        Parameters

        • position: {
              left: number;
              top: number;
              width: number;
              height: string | number;
              scale: number;
          } = {}

          Positional data

          • left: number

            The left offset position in pixels

          • top: number

            The top offset position in pixels

          • width: number

            The application width in pixels

          • height: string | number

            The application height in pixels

          • scale: number

            The application scale as a numeric factor where 1.0 is default

        Returns void | {
            left: number;
            top: number;
            width: number;
            height: number;
            scale: number;
        }

      • Protected

        Display a menu of compendium types to filter by

        Parameters

        • event: PointerEvent

          The originating pointer event

        Returns Promise<void>

      • Protected

        Handle toggling a compendium type filter

        Parameters

        • event: PointerEvent

          The originating pointer event

        • type: string

          The compendium type to filter by. If null, clear all filters.

        Returns void

      • Protected

        Get the dropped Entry from the drop data

        Parameters

        • data: object

          The data being dropped

        Returns Promise<object>

        The dropped Entry

      • Protected Internal

        Call all hooks for all applications in the inheritance chain.

        Parameters

        • hookName: string | ((className) => string)

          The hook being triggered, which formatted with the Application class name

        • Rest ...hookArgs: any[]

          The arguments passed to the hook calls

        Returns void

      • Protected

        Persist the scroll positions of containers within the app before re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      • Protected

        Restore the scroll positions of containers within the app after re-rendering the content

        Parameters

        • html: jQuery

          The HTML object being traversed

        Returns void

      • Protected

        Render the outer application wrapper

        Returns Promise<jQuery>

        A promise resolving to the constructed jQuery object

      • Protected

        Specify the set of config buttons which should appear in the Application header. Buttons should be returned as an Array of objects. The header buttons which are added to the application can be modified by the getApplicationHeaderButtons hook.

        Returns ApplicationHeaderButton[]

        Fires

        getApplicationHeaderButtons

      • Protected

        Activate required listeners which must be enabled on every Application. These are internal interactions which should not be overridden by downstream subclasses.

        Parameters

        • html: jQuery

        Returns void

      • Protected

        Handle changes to the active tab in a configured Tabs controller

        Parameters

        • event: MouseEvent

          A left click event

        • tabs: Tabs

          The Tabs controller

        • active: string

          The new active tab name

        Returns void

      • Protected

        Handle changes to search filtering controllers which are bound to the Application

        Parameters

        • event: KeyboardEvent

          The key-up event from keyboard input

        • query: string

          The raw string input to the search field

        • rgx: RegExp

          The regular expression to test against

        • html: HTMLElement

          The HTML element which should be filtered

        Returns void

      • Protected

        Define whether a user is able to begin a dragstart workflow for a given drag selector

        Parameters

        • selector: string

          The candidate HTML selector for dragging

        Returns boolean

        Can the current user drag this selector?

      • Protected

        Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector

        Parameters

        • selector: string

          The candidate HTML selector for the drop target

        Returns boolean

        Can the current user drop on this selector?

      • Protected

        Callback actions which occur at the beginning of a drag start workflow.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      • Protected

        Callback actions which occur when a dragged element is over a drop target.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      • Protected

        Callback actions which occur when a dragged element is dropped on a target.

        Parameters

        • event: DragEvent

          The originating DragEvent

        Returns void

      • Protected

        Wait for any images present in the Application to load.

        Returns Promise<void>

        A Promise that resolves when all images have loaded.

      • Private

        Handle a Compendium Pack deletion request

        Parameters

        • pack: object

          The pack object requested for deletion

        Returns Promise<any>