mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-24 06:35:10 +00:00
3d09f89251
- W17.C: refresh 5 stale @example blocks (types.ts, lifecycle.ts, node.ts,
imperatives.ts ×2) — replace deprecated `async setup()` with
`setup() { onMounted(...) }`; remove A1-removed `node.getWidget` from
defineNode + NodeHandle.on migration examples; align imperatives examples
with W17.B notify-toast verdict.
- W17.D: author ~37 new @example blocks across 9 files for sparse exports
surfaced by W17.A audit. Pure JSDoc — zero exported-type diff.
- W17.E: add @deprecated JSDoc to notify() + NotifyOptions per
D-notify-toast-consolidation (W17.B verdict (a) soft-deprecate).
Pure JSDoc — no signature, type, or export changes.
Phase A surface remains FROZEN at ee0537fdb5 (foundation surface SHA
unchanged; only @example / @deprecated text differs).
See research/dashboard-snippet-audit-2026-05-21.md (W17.A) for full
per-edit rationale.
67 lines
2.1 KiB
TypeScript
67 lines
2.1 KiB
TypeScript
/**
|
|
* Shell UI extension types — sidebar tabs, bottom panels, commands, hotkeys,
|
|
* settings, about badges, toolbar buttons, toasts.
|
|
*
|
|
* Re-exported from `src/types/extensionTypes.ts` with no shape changes. Each
|
|
* registerable shell UI surface has its own `defineX` entry point in
|
|
* `@/extension-api/registrations`; the arg types for those entries are
|
|
* re-exported here. Toast + notification surfaces remain inline-imperative
|
|
* (see `@/extension-api/imperatives`).
|
|
*
|
|
* @packageDocumentation
|
|
*/
|
|
|
|
// VueExtension and CustomExtension are intentionally NOT re-exported — they
|
|
// are discriminated-union ingredients of SidebarTabExtension /
|
|
// BottomPanelExtension, not author-facing entry points. Internal callers
|
|
// (ExtensionSlot.vue) import them directly from '@/types/extensionTypes'.
|
|
export type {
|
|
// Pre-existing types (unchanged shape)
|
|
/**
|
|
* Options bag for {@link defineSidebarTab}.
|
|
* @see {@link defineSidebarTab} for a usage example.
|
|
*/
|
|
SidebarTabExtension,
|
|
/**
|
|
* Options bag for {@link defineBottomPanelTab}.
|
|
* @see {@link defineBottomPanelTab} for a usage example.
|
|
*/
|
|
BottomPanelExtension,
|
|
/**
|
|
* Options bag for {@link toast.show} / {@link toast.remove}.
|
|
* @see {@link toast} for a usage example.
|
|
*/
|
|
ToastMessageOptions,
|
|
/**
|
|
* Manager interface backing the {@link toast} surface.
|
|
* @see {@link toast} for a usage example.
|
|
*/
|
|
ToastManager,
|
|
// Net-new shell-UI arg types
|
|
/**
|
|
* Options bag for {@link defineCommand}.
|
|
* @see {@link defineCommand} for a usage example.
|
|
*/
|
|
CommandDefinition,
|
|
/**
|
|
* Options bag for {@link defineHotkey}.
|
|
* @see {@link defineHotkey} for a usage example.
|
|
*/
|
|
HotkeyExtension,
|
|
/**
|
|
* Options bag for {@link defineAboutBadge}.
|
|
* @see {@link defineAboutBadge} for a usage example.
|
|
*/
|
|
AboutBadgeExtension,
|
|
/**
|
|
* Options bag for {@link defineSetting}.
|
|
* @see {@link defineSetting} for a usage example.
|
|
*/
|
|
SettingDefinition,
|
|
/**
|
|
* Options bag for {@link defineToolbarButton}.
|
|
* @see {@link defineToolbarButton} for a usage example.
|
|
*/
|
|
ToolbarButtonExtension
|
|
} from '@/types/extensionTypes'
|