CompendiumDirectory

CompendiumDirectory

A compendium of knowledge arcane and mystical!

Constructor

new CompendiumDirectory()

Extends

Members

(static) defaultOptions

_original :SidebarTab

Inherited From:

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

Type:

(protected) _popout :SidebarTab

Inherited From:

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

Type:

tabName :string

Inherited From:

The base name of this sidebar tab

Type:
  • string

Methods

(protected) _contextMenu(html)

Compendium sidebar Context Menu creation

Parameters:
Name Type Description
html jQuery

The HTML being rendered for the compendium directory

_onLazyLoadImage(entries, observer)

Inherited From:

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

Parameters:
Name Type Description
entries Array.<HTMLElement>

The entries which are now observed

observer IntersectionObserver

The intersection observer instance

(async) _render()

Inherited From:

(async) _renderInner()

Inherited From:

_toggleOpenState(pack)

Toggle the compendium entry open/closed state in the sidebar.

Parameters:
Name Type Description
pack string

The name of the compendium pack.

activate()

Inherited From:

Activate this SidebarTab, switching focus to it

activateListeners()

(async) close()

Inherited From:

createPopout() → {SidebarTab}

Inherited From:

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

Returns:

The popped out sidebar tab instance

Type
SidebarTab

getData()

renderPopout()

Inherited From:

Render the SidebarTab as a pop-out container