pastilhasandClaude Opus 5
543e88a9a6
an exclusionary rule, made structural. a plugin does not render a screen: it
contributes panels and says how they are arranged, and the shell renders
WorkspaceView around them.
web/panels.ts appRegistryMetas — at least one panel
web/layout.ts defaultLayout — how they are arranged
both required the moment web/ exists, and missing either is refused at discovery
by name and with the reason. tested:
probeplug: has a web/ directory but is missing web/layout.ts.
Every plugin route renders a Workspace: contribute panels and a layout,
not a screen.
there is deliberately no way to export a component. one that could would be free
to render a bare div, a full-page form, or its own navigation, and the platform
would become a shell hosting strangers' layouts rather than one application.
non-compliance is not so much refused as unrepresentable — there is nowhere to
put a screen.
the shell registers <prefix> and <prefix>/:section, exactly as the core screens
do, so a plugin's sections stay addressable and cmd-clickable, and panels read
useParams independently rather than passing state between themselves.
appTypes.allowed is pinned to that plugin's own keys, so a persisted layout
naming something else falls back instead of rendering another plugin's panel
inside this screen.
the example plugin is rebuilt to model it — two panels, a layout, one of them
calling its own /api/example/ping through useClient — because the reference
implementation is what everyone copies.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
17 lines
927 B
TypeScript
17 lines
927 B
TypeScript
import { Puzzle, ListTree } from 'lucide-react';
|
|
import type { AppRegistryMeta } from 'officerdev';
|
|
import { ExampleOverview } from './ExampleOverview';
|
|
import { ExampleDetail } from './ExampleDetail';
|
|
|
|
// The panels this plugin contributes. AT LEAST ONE, or discovery refuses the plugin.
|
|
//
|
|
// A plugin never renders a screen — the shell renders `WorkspaceView` around these, arranged by
|
|
// `layout.ts`. That is what makes "every plugin route is a Workspace" a property of the shape rather than
|
|
// a rule someone has to remember.
|
|
//
|
|
// `availableOnPanel: false` keeps them off the generic panel picker: they belong to this plugin's screen.
|
|
export const appRegistryMetas: AppRegistryMeta[] = [
|
|
{ key: 'example-overview', name: 'Overview', icon: Puzzle, component: ExampleOverview, availableOnPanel: false },
|
|
{ key: 'example-detail', name: 'Detail', icon: ListTree, component: ExampleDetail, availableOnPanel: false },
|
|
];
|