Skip to content
Void Monster Docs

Type to search guides and API reference.

    OBS Utils/Developer docs

    Interface: DirectorTabSvelte5Registration

    Public 5.3.0API 5.3.0

    @faeyumbrea/obs-utils-api-types


    @faeyumbrea/obs-utils-api-types / DirectorTabSvelte5Registration

    Defined in: api.d.ts:75

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

    optional icon?: string

    Defined in: api.d.ts:78


    key: string

    Defined in: api.d.ts:76


    label: string

    Defined in: api.d.ts:77


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

    Defined in: api.d.ts:83

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

    HTMLElement

    boolean

    () => void


    optional order?: number

    Defined in: api.d.ts:86