Tidy 5e Sheets API
    Preparing search index...

    Class SvelteTab

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    component? enabled? getContext? getProps? iconClass? onRender? renderScheme? tabContentsClasses? tabId title

    Constructors

    Properties

    component?: Component<{}, {}, string> = undefined

    A reference to the .svelte component.

    enabled?: (data: any) => boolean

    Optional function to determine whether the tab should be visible when viewing the sheet. When excluded, it defaults to true.

    getContext?: (context: Map<any, any>) => Map<any, any>

    An optional function that provides the relevant svelte context map and expects the component's ideal context map in return.

    For most sheets, a guaranteed entry in the context map is a readable store of the sheet's application context (item sheet context, character sheet context, NPC sheet context, etc.).

    getProps?: (data: any) => Record<string, any>

    An optional function that provides the relevant application context (item sheet context, character sheet context, NPC sheet context, etc.) and expects an object in return. The return value is passed to the svelte component as its props.

    iconClass?: string

    A FontAwesome icon class string. If provided, an icon will be included with the tab.

    onRender?: (params: OnRenderTabParams) => 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 = 'force'

    For svelte-based tabs, the render scheme is set to 'force' and generally ignored.

    tabContentsClasses?: string[] = []

    An optional array of CSS classes to apply to the tab contents container.

    tabId: string = ''

    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:

    • for modules, use your module ID as a prefix (e.g., "my-module-id")
      • for world scripts, use your game world name (e.g., "my-game-world")
    • add a hyphenated version of the tab title (e.g., for a tab titled "My Spellbook Tab", use "my-spellbook-tab")
    • join these two pieces together with a hyphen:
    "my-module-id-my-spellbook-tab"
    title: CustomTabTitle = ''

    The title to display on the tab. Accepts localization keys and plain text.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties