Class HandlebarsContent

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

Remarks

The default sheet listeners pertain to the default 5e sheets. Behaviors include but are not limited to

• data-action click handling
• drag-and-drop behaviors
• rollable items click handling
• item controls click handling
• proficiency toggling
• ... etc.

Leaving this field false means you wish to take full control of the event handling of your content.

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

An optional function that provides the relevant application context (item sheet context, character sheet context, NPC sheet context, etc.) and expects the same data or a replacement object in return. The return value is passed to the Handlebars template.

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.

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().

The path to the handlebars template. Use a leading slash to look in the UserData directory.

Example: A template in a module's templates directory

"/modules/my-module-id/templates/my-module-template.hbs"

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