Skip to content
Void Monster Docs

Type to search guides and API reference.

    OBS Utils/Developer docs

    Interface: DirectorTabRegistration

    Public 5.3.0API 5.3.0

    @faeyumbrea/obs-utils-api-types


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

    Defined in: api.d.ts:56

    Public compile-time contract for modules integrating with OBS Utils.

    component: Component

    Defined in: api.d.ts:64

    Svelte component rendered when this tab is active. Receives { disabled } prop.


    optional icon?: string

    Defined in: api.d.ts:62

    Optional Font Awesome icon class for the tab button.


    key: string

    Defined in: api.d.ts:58

    Unique key — namespace with your module id (e.g. ‘my-module.weatherTab’).


    label: string

    Defined in: api.d.ts:60

    i18n key for the tab button label.


    optional order?: number

    Defined in: api.d.ts:66

    Sort order. Built-ins use 10/20/30; default for module tabs is 100 (placed after built-ins).