@oneplatform/plugin-sdk / WidgetMetadata

Interface: WidgetMetadata¶

Defined in: packages/plugin-sdk/src/types/metadata.ts:122

Extends¶

BaseMetadata

Properties¶

author¶

author: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:25

Plugin author name or organization.

Inherited from¶

BaseMetadata.author

configSchema¶

configSchema: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:31

JSON Schema for the tenant-admin configuration form.

Inherited from¶

BaseMetadata.configSchema

description¶

description: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:19

Brief description shown in the marketplace. 10-500 characters.

Inherited from¶

BaseMetadata.description

icon?¶

optional icon?: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:28

URL or data URI for the plugin icon. PNG or SVG, max 64KB.

Inherited from¶

BaseMetadata.icon

id¶

id: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:13

Must match manifest.id exactly.

Inherited from¶

BaseMetadata.id

maxHeight?¶

optional maxHeight?: number

Defined in: packages/plugin-sdk/src/types/metadata.ts:135

Maximum grid height. Omit for no constraint.

maxWidth?¶

optional maxWidth?: number

Defined in: packages/plugin-sdk/src/types/metadata.ts:132

Maximum grid width. Omit for no constraint.

minHeight¶

minHeight: number

Defined in: packages/plugin-sdk/src/types/metadata.ts:129

Minimum grid height. Integer 1-12.

minWidth¶

minWidth: number

Defined in: packages/plugin-sdk/src/types/metadata.ts:126

Minimum grid width. Integer 1-12.

name¶

name: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:16

Human-readable display name. 2-100 characters.

Inherited from¶

BaseMetadata.name

slots¶

slots: WidgetSlotDeclaration[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:138

Slots this widget can render in.

tags?¶

optional tags?: string[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:34

Discoverability tags shown in the marketplace filter UI.

Inherited from¶

BaseMetadata.tags

type¶

readonly type: "widget"

Defined in: packages/plugin-sdk/src/types/metadata.ts:123

version¶

version: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:22

Must match manifest.version exactly.

Inherited from¶

BaseMetadata.version