Tidy 5e Sheets API
    Preparing search index...

    Class HtmlContent

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    enabled?: (context: any) => boolean

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

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

    The HTML to be injected into the sheet.

    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 Foundry Application would normally call render().

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