@scalar/api-reference/dist/v2/blocks/scalar-sidebar-block/hooks/useSidebar.d.ts

Generate beautiful API references from OpenAPI documents

import type { WorkspaceStore } from '@scalar/workspace-store/client';
import { type InjectionKey } from 'vue';
import { createSidebar } from '../../../../v2/blocks/scalar-sidebar-block/helpers/create-sidebar.js';
type Sidebar = ReturnType<typeof createSidebar>;
/**
 * Injection key for the sidebar instance.
 * This ensures type safety when injecting the sidebar.
 */
export declare const SIDEBAR_SYMBOL: InjectionKey<Sidebar>;
/**
 * Composable for managing the sidebar state.
 *
 * When called with a collection and options, it creates and provides a new sidebar instance.
 * When called without parameters, it returns the injected sidebar state.
 */
export declare const useSidebar: (store?: WorkspaceStore) => ReturnType<typeof createSidebar>;
export {};
//# sourceMappingURL=useSidebar.d.ts.map