@scalar/api-client
Version:
the open source API testing client
44 lines • 1.9 kB
TypeScript
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
/**
* Command Palette Example Component
*
* Provides a form for creating a new example for an API operation.
* Users can name the example, select a document (collection), and choose an operation.
* Automatically navigates to the example route which creates the example.
*
* @example
* <CommandPaletteExample
* :workspaceStore="workspaceStore"
* @close="handleClose"
* @back="handleBack"
* />
*/
declare const _default: typeof __VLS_export;
export default _default;
declare const __VLS_export: import("vue").DefineComponent<{
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting operation creation events */
eventBus: WorkspaceEventBus;
/** Document id to create the example for */
documentName?: string;
/** Preselected path and method to create the example for */
operationId?: string;
}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
close: () => any;
back: (keyboardEvent: KeyboardEvent) => any;
}, string, import("vue").PublicProps, Readonly<{
/** The workspace store for accessing documents and operations */
workspaceStore: WorkspaceStore;
/** Event bus for emitting operation creation events */
eventBus: WorkspaceEventBus;
/** Document id to create the example for */
documentName?: string;
/** Preselected path and method to create the example for */
operationId?: string;
}> & Readonly<{
onClose?: (() => any) | undefined;
onBack?: ((keyboardEvent: KeyboardEvent) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
//# sourceMappingURL=CommandPaletteExample.vue.d.ts.map