Skip to main content
Version: 5.0

Interface: DirectorTabSvelte5Registration

Defined in: api.ts:102

Cross-bundle-safe Director tab. Instead of a component, you pass a mount callback that mounts the tab with your own module's Svelte mount(). A Svelte 5 component from another bundle cannot be mounted by OBS Utils' runtime — its runes resolve against your bundle's effect context, so OBS Utils mounting it throws effect_orphan. Letting your module mount it fixes that. (A Svelte 4 module can new Component() inside the same callback.)

Properties

icon?

optional icon?: string

Defined in: api.ts:105


key

key: string

Defined in: api.ts:103


label

label: string

Defined in: api.ts:104


mount

mount: (target, props) => () => void

Defined in: api.ts:110

Mount the tab UI into target (e.g. mount(MyTab, { target, props })) and return a cleanup function that tears it down (e.g. () => unmount(app)).

Parameters

target

HTMLElement

props
disabled

boolean

Returns

() => void


order?

optional order?: number

Defined in: api.ts:111