Wrap a callback in a debounced timeout. Delay execution of the callback function until the function has not been called for delay milliseconds
Rest ...args: [force?: boolean, options?: RenderOptions<ApplicationOptions>]A wrapped function which can be called to debounce execution
Readonly entriesThe Collection of index entries this browser is aware of.
A set of filters that were expanded by the user, and should stay expanded upon re-render.
The set of filters to apply to the compendium index.
The types of entries this browser handles, as per a document's type property.
Compendium packs this browser gets entries from.
Static ENTRY_The template used to render individual entries in the browser.
Static documentThe document name of entries this browser displays.
Static filterAn array of classes extending BaseFilter that should be used for this browser.
Static typeA localisation string used in the browser's title.
Static typesStatic defaultProtected _getGet the current set of entries allowed by the filters.
The filtered entries
Protected initializeLoad a compendium's index to prepare it for browsing.
The compendium to load
The loaded index entries
Static _mapStatic getRequest indexes of all packs of a document type to be loaded. This method should only ever be called as CompendiumBrowser.getIndexes to ensure Promises are properly bundled.
The names of the packs to load indexes for
A Promise that resolves once all indexes have been loaded
CompendiumBrowser.#indexingPromise
Static initializeInitialize all CompendiumBrowsers found in pf1.applications.compendiumBrowser and register them in pf1.applications.compendiums.
Generated using TypeDoc
The basic compendium browser class allowing the browsing of compendiums by utilising their indexes.
Extending classes must define the following static properties if the browser is not meant to browse Item documents: documentName. Extending classes should define the following static properties: typeName, filterClasses.
Abstract