@scalar/api-client
Version:
the open source API testing client
36 lines • 1.94 kB
TypeScript
import { type ModalState } from '@scalar/components';
import type { HttpMethod } from '@scalar/helpers/http/http-methods';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceDocument } from '@scalar/workspace-store/schemas';
import { type ComputedRef } from 'vue';
import { type UseModalSidebarReturn } from '../../../v2/features/modal/hooks/use-modal-sidebar.js';
import type { ClientPlugin } from '../../../v2/helpers/plugins.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 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[];
};
/**
* Scalar Api Client Modal
*
* This component is used to render the API Client Modal
*/
declare const _default: 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>;
export default _default;
//# sourceMappingURL=Modal.vue.d.ts.map