Optional
enabledOptional function to determine whether the tab should be visible when viewing the sheet. When excluded, it defaults to true
.
Optional
getAn 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 HTML callback function, if the callback function is used.
A string of HTML or a function which returns HTML.
By default, the function will pass in the sheet context data for the relevant sheet which is being rendered.
If getData
is used, then whatever getData
returned will be provided here instead.
Optional
iconA FontAwesome icon class string. If provided, an icon will be included with the tab.
Optional
onOptional 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()
.
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".
An optional array of CSS classes to apply to the tab contents container.
The required static ID associated with a tab.
A tabId
is a unique string of text that identifies your tab.
It needs to be in a format that can be put into an HTML attribute.
The tab ID is always required to register a tab.
A tabId
must be unique to the target sheet. For example,
the character sheet can only have one "my-module-id-my-spellbook-tab" ID,
and the NPC sheet can also only have one "my-module-id-my-spellbook-tab" ID, etc.
Advice for crafting a unique tab ID:
"my-module-id-my-spellbook-tab"
The title to display on the tab. Accepts localization keys and plain text.