# @embedpdf/plugin-shell — ./contract/host MenuEvent [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface MenuEvent{ readonly id: string; } OpenSurfaceOptions [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface OpenSurfaceOptions{ readonly exclusive?: string; readonly props?: SurfaceProps; } ShellAction [TypeAliasDeclaration] (from packages/plugin/shell/src/model.ts): export type ShellAction = |{ type: 'SHELL/OPEN_SURFACE'; id: string; exclusive?: string; props?: SurfaceProps} |{ type: 'SHELL/CLOSE_SURFACE'; id: string} |{ type: 'SHELL/TOGGLE_SURFACE'; id: string; exclusive?: string; props?: SurfaceProps} |{ type: 'SHELL/SET_SURFACE_PROPS'; id: string; props: SurfaceProps} |{ type: 'SHELL/CLOSE_ALL_SURFACES'} |{ type: 'SHELL/OPEN_MENU'; id: string} |{ type: 'SHELL/CLOSE_MENU'; id: string} |{ type: 'SHELL/CLOSE_ALL_MENUS'} |{ type: 'SHELL/APPLY_SNAPSHOT'; snapshot: ShellSnapshot} ; ShellCapability [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface ShellCapability{ isOpen(id: string): boolean; getSurface(id: string): SurfaceState | null; listOpenSurfaces(): readonly SurfaceState[]; open(id: string, options?: OpenSurfaceOptions): void; close(id: string): void; toggle(id: string, options?: OpenSurfaceOptions): void; updateSurfaceProps(id: string, props: SurfaceProps): void; closeAll(): void; isMenuOpen(id: string): boolean; listOpenMenus(): readonly string[]; openMenu(id: string): void; closeMenu(id: string): void; toggleMenu(id: string): void; closeAllMenus(): void; getSnapshot(): ShellSnapshot; applySnapshot(snapshot: ShellSnapshot): void; readonly onSurfaceOpened: EventHook; readonly onSurfaceClosed: EventHook; readonly onMenuOpened: EventHook; readonly onMenuClosed: EventHook; } ShellHostCapability [TypeAliasDeclaration]: export type ShellHostCapability = ShellCapability; ShellSnapshot [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface ShellSnapshot{ readonly surfaces: Readonly>>; readonly openMenus: readonly string[]; } ShellState [InterfaceDeclaration] (from packages/plugin/shell/src/model.ts): export interface ShellState{ readonly surfaces: Readonly>; readonly openMenus: readonly string[]; } ShellToken [VariableDeclaration] (from packages/plugin/shell/src/token.ts): ShellToken = createCapabilityToken('shell', { hint: `add shellPlugin() from '@embedpdf/plugin-shell' to your plugins list`, } ) SurfaceEvent [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface SurfaceEvent{ readonly id: string; readonly props?: SurfaceProps; } SurfaceProps [TypeAliasDeclaration] (from packages/plugin/shell/src/contract.ts): export type SurfaceProps = Readonly>; SurfaceState [InterfaceDeclaration] (from packages/plugin/shell/src/contract.ts): export interface SurfaceState{ readonly id: string; readonly open: boolean; readonly exclusive?: string; readonly props?: SurfaceProps; }