Class HtmlContent

Hierarchy (view full)

Constructors

constructor

Properties

enabled? html injectParams? onContentReady? onRender? renderScheme

Accessors

activateDefaultSheetListeners

Constructors

constructor

Properties

Optionalenabled

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

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

html

html: string | ((data: any) => string) = ''

The HTML to be injected into the sheet.

OptionalinjectParams

injectParams?: CustomContentInjectParams

OptionalonContentReady

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.

Remarks

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.

OptionalonRender

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: RenderScheme = 'handlebars'

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".

Accessors

activateDefaultSheetListeners

  • get activateDefaultSheetListeners(): undefined | boolean

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

    Returns undefined | boolean

    Deprecated

    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.

  • set activateDefaultSheetListeners(value): void

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

    Parameters

    • value: undefined | boolean

    Returns void

    Deprecated

    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.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors