Class CustomContentBaseAbstract

Hierarchy (view full)

Constructors

Properties

activateDefaultSheetListeners?: boolean

An optional override to whether the target content should use default sheet event listeners. Defaults to false.

Tidy is moving to Application V2, and there will no longer be any default sheet listeners. Be sure to provide your own event handling for the content that is injected.

enabled?: ((context: any) => boolean)

Optional function to determine whether the content should be rendered. When excluded, it defaults to true.

onContentReady?: ((params: OnContentReadyParams) => void)

After the custom content has been prepared for rendering and is ready to inject into the sheet, this callback is invoked.

For more complex HTML insertion scenarios, one can skip CustomContentInjectParams and simply inject the prepared content with this callback.

This callback is also useful for quick debug logging of the content to be rendered.

onRender?: ((params: OnRenderParams) => void)

Optional function which is called each time a change detection cycle occurs on the sheet. This is any time a FormApplication would normally call render().

renderScheme?: RenderScheme

Optionally determines whether to refresh content each time an application render occurs.

For svelte-based content, the default is "force". For HTML and Handlebars content, the default is "handlebars".