@scalar/api-client
Version:
the open source API testing client
66 lines • 2.89 kB
TypeScript
import type { SidebarState } from '@scalar/sidebar';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
import type { Workspace } from '../../../../v2/hooks/use-workspace-selector.js';
import type { ClientLayout } from '../../../../v2/types/layout';
type __VLS_Props = {
/**
* The current layout of the app (e.g., 'desktop', 'web')
*/
layout: ClientLayout;
/**
* The sidebar state, holding navigation items and state
*/
sidebarState: SidebarState<TraversedEntry>;
/**
* Whether the workspace overview sidebar is currently open
*/
isWorkspaceOpen?: boolean;
/**
* The currently active workspace.
* This represents the workspace that the user is currently working in.
*/
activeWorkspace: Workspace;
/**
* The list of all available workspaces.
* Used to render options for workspace switching and selection.
*/
workspaces: Workspace[];
/**
* The workspace event bus for handling workspace-level events.
* Used for triggering and responding to workspace changes and actions.
*/
eventBus: WorkspaceEventBus;
/**
* The WorkspaceStore instance for managing workspace state and actions.
* Provides methods and state for interacting with the current workspace.
*/
store: WorkspaceStore;
};
type __VLS_PublicProps = __VLS_Props & {
/** Controls the visibility of the sidebar */
'isSidebarOpen': boolean;
/** Controls the width of the sidebar */
'sidebarWidth': number;
};
declare const _default: import("vue").DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
"update:isSidebarOpen": (value: boolean) => any;
"update:sidebarWidth": (value: number) => any;
} & {
"create:workspace": () => any;
"select:workspace": (id?: string | undefined) => any;
selectItem: (id: string) => any;
"open:commandPalette": (action?: "import" | undefined) => any;
"click:workspace": () => any;
}, string, import("vue").PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
"onCreate:workspace"?: (() => any) | undefined;
"onSelect:workspace"?: ((id?: string | undefined) => any) | undefined;
onSelectItem?: ((id: string) => any) | undefined;
"onUpdate:isSidebarOpen"?: ((value: boolean) => any) | undefined;
"onUpdate:sidebarWidth"?: ((value: number) => any) | undefined;
"onOpen:commandPalette"?: ((action?: "import" | undefined) => any) | undefined;
"onClick:workspace"?: (() => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
//# sourceMappingURL=AppSidebar.vue.d.ts.map