@scalar/api-client/dist/v2/features/modal/Modal.vue.d.ts

the open source API testing client

import { type ModalState } from '@scalar/components';
import type { HttpMethod } from '@scalar/helpers/http/http-methods';
import type { ClientPlugin } from '@scalar/oas-utils/helpers';
import type { ApiReferenceConfigurationRaw } from '@scalar/types/api-reference';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import { type WorkspaceEventBus } from '@scalar/workspace-store/events';
import type { WorkspaceDocument } from '@scalar/workspace-store/schemas';
import { type ComputedRef, type MaybeRefOrGetter } from 'vue';
import { type UseModalSidebarReturn } from '../../../v2/features/modal/hooks/use-modal-sidebar.js';
export type ModalProps = {
    /** The workspace store must be initialized and passed in */
    workspaceStore: WorkspaceStore;
    /** The document must be initialized and passed in */
    document: ComputedRef<WorkspaceDocument | null>;
    /** The path must be initialized and passed in */
    path: ComputedRef<string | undefined>;
    /** The event bus for handling all events */
    eventBus: WorkspaceEventBus;
    /** The method must be initialized and passed in */
    method: ComputedRef<HttpMethod | undefined>;
    /** The example name must be initialized and passed in */
    exampleName: ComputedRef<string | undefined>;
    /** Controls the visibility of the modal */
    modalState: ModalState;
    /** The sidebar state must be initialized and passed in */
    sidebarState: UseModalSidebarReturn;
    /** Api client plugins to include in the modal */
    plugins: ClientPlugin[];
    /** Subset of the configuration options for the modal */
    options: MaybeRefOrGetter<Partial<Pick<ApiReferenceConfigurationRaw, 'authentication' | 'baseServerURL' | 'hideClientButton' | 'hiddenClients' | 'servers'>>>;
};
/**
 * Scalar Api Client Modal
 *
 * This component is used to render the API Client Modal
 */
declare const _default: typeof __VLS_export;
export default _default;
declare const __VLS_export: import("vue").DefineComponent<ModalProps, {
    sidebarWidth: ComputedRef<number>;
    environment: ComputedRef<import("@scalar/workspace-store/schemas/extensions/document/x-scalar-environments").XScalarEnvironment>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<ModalProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
//# sourceMappingURL=Modal.vue.d.ts.map