@dxos/app-framework - v0.9.0
    Preparing search index...

    Type Alias Meta

    type Meta = {
        author?: string;
        dependsOn?: string[];
        description?: string;
        homePage?: string;
        icon?: string;
        iconHue?: string;
        id: string;
        key: DXN.DXN;
        name: string;
        screenshots?: string[];
        source?: string;
        spec?: string;
        tags?: string[];
        version?: string;
    }
    Index

    Properties

    author? dependsOn? description? homePage? icon? iconHue? id key name screenshots? source? spec? tags? version?

    Properties

    author?: string

    Name of the author or organization that created the plugin.

    dependsOn?: string[]

    IDs of plugins this plugin functionally depends on.

    Treated as a convenience by the default PluginManager flow:

    • Enabling this plugin auto-enables the transitive closure of dependsOn (installing missing entries from the plugin registry when possible).
    • Disabling a depended-upon plugin surfaces dependents to the caller; the PluginManager.disable API supports an opt-in cascade.

    Not an invariant: low-level PluginManager APIs accept opt-outs (resolveDependencies: false, ignoreDependents: true) so a caller may substitute an alternative implementation that satisfies the dependent's capability needs in its own way.

    description?: string

    Short description of plugin functionality.

    homePage?: string

    URL of home page.

    icon?: string

    A grep-able symbol string which can be resolved to an icon asset by @ch-ui/icons, via @ch-ui/vite-plugin-icons.

    iconHue?: string

    Icon hue (ChromaticPalette).

    id: string

    Bare NSID (the name portion of key, e.g. org.dxos.plugin.example). Stable across versions; used for module-id namespacing, i18n namespaces, enable/disable, and registry lookups. Derived from key by makeMeta — do not set directly.

    key: DXN.DXN

    Canonical identity DXN, including version when published (e.g. dxn:org.dxos.plugin.example:0.8.3). The validated source of truth from which id and version are derived.

    DXN.make('org.dxos.plugin.example', '0.8.3')
    name: string

    Human-readable name.

    screenshots?: string[]

    URL of screenshot.

    source?: string

    URL of source code.

    spec?: string

    Relative path (inside the published package) to the plugin's bundled MDL specification file — e.g. 'PLUGIN.mdl' or 'docs/PLUGIN.mdl'. The file is shipped via the package's files entry and resolved by registry surfaces to render an in-app viewer and/or external link.

    tags?: string[]

    Tags to help categorize the plugin.

    version?: string

    Semver version string of the plugin, typically the publishing package's package.json version. Derived from the version segment of key by makeMeta — do not set directly.

    Settings

    Member Visibility

    On This Page

    Properties