@scalar/api-client
Version:
the open source API testing client
41 lines • 1.81 kB
TypeScript
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
import type { UseCommandPaletteStateReturn } from '../../../../v2/features/command-palette/hooks/use-command-palette-state.js';
/**
* The Command Palette Component
*
* A keyboard-driven command menu for quick access to common actions like:
* - Creating documents, requests, tags, and examples
* - Importing from OpenAPI, Swagger, Postman, or cURL
* - Navigating to different routes
*
* Supports:
* - Fuzzy search filtering
* - Keyboard navigation (arrow keys, enter, escape)
* - Command grouping and organization
* - Dynamic command components with props
*
* @example
* <TheCommandPalette
* :paletteState="paletteState"
* :workspaceStore="workspaceStore"
* :eventBus="eventBus"
* />
*/
declare const _default: import("vue").DefineComponent<{
/** The command palette state management hook */
paletteState: UseCommandPaletteStateReturn;
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting workspace events */
eventBus: WorkspaceEventBus;
}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
/** The command palette state management hook */
paletteState: UseCommandPaletteStateReturn;
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting workspace events */
eventBus: WorkspaceEventBus;
}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
//# sourceMappingURL=TheCommandPalette.vue.d.ts.map