@deot/docs-playground 1.1.0 → 1.1.2

package/dist/index.d.ts

@@ -7,8 +7,10 @@ import { Language } from '@deot/docs-locale';
 import type { LanguageFn } from 'highlight.js';
 import { Portal } from '@deot/vc';
 import { PublicProps } from 'vue';
+import type { Ref } from 'vue';
 import type { SandboxProps } from '@vue/repl';
 import type { StoreState } from '@vue/repl';
+import { vue } from 'vue';
 
 declare const __VLS_export: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
 language: string;
@@ -38,6 +40,7 @@ entry: string;
 modelValue: string;
 options: PlaygroundOptions;
 previewInset: PlaygroundPreviewInset;
+previewScroller: PlaygroundPreviewScroller;
 styleless: boolean;
 id: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
@@ -63,6 +66,7 @@ declare type __VLS_Props_2 = {
     expandable?: PlaygroundExpandable;
     title?: string;
     id?: string;
+    previewScroller?: PlaygroundPreviewScroller;
     previewOptions?: PlaygroundPreviewOptions;
     locale?: Language;
 };
@@ -83,7 +87,11 @@ export declare const createBuiltinImports: (cdnURL?: string) => Record<string, s
 
 export declare const createBuiltinStyles: (cdnURL?: string) => Record<string, string>;
 
-export declare const createRuntimePreviewOptions: (cdnURL?: string) => NonNullable<SandboxProps["previewOptions"]>;
+declare interface CreateRuntimePreviewOptions {
+    previewScroller?: boolean;
+}
+
+export declare const createRuntimePreviewOptions: (cdnURL?: string, options?: CreateRuntimePreviewOptions) => NonNullable<SandboxProps["previewOptions"]>;
 
 export declare const DEFAULT_CDN_URL = "https://cdn.jsdelivr.net/npm";
 
@@ -179,6 +187,36 @@ export declare type PlaygroundPreviewInset = number | [vertical: number, horizon
 
 export declare type PlaygroundPreviewOptions = SandboxProps['previewOptions'];
 
+export declare type PlaygroundPreviewScroller = boolean;
+
+export declare interface PlaygroundRunOptions {
+    visible?: Ref<boolean> | (() => boolean);
+}
+
+export declare class PlaygroundService {
+    private readonly target;
+    private readonly vue;
+    private readonly session;
+    private sequence;
+    private disposed;
+    private manual?;
+    private readonly requests;
+    private readonly owners;
+    constructor(target: Window, vue: PreviewVue);
+    enable(height: number): Promise<boolean>;
+    disable(): void;
+    run(height: number): (visible: boolean) => Promise<boolean | undefined>;
+    run<Args extends unknown[], Result>(height: number, handler: (...args: Args) => Result): (...args: Args) => Promise<Awaited<Result> | undefined>;
+    run<Args extends unknown[], Result>(height: number, options: PlaygroundRunOptions, handler: (...args: Args) => Result): (...args: Args) => Promise<Awaited<Result> | undefined>;
+    run(height: number, options: PlaygroundRunOptions & {
+        visible: Ref<boolean>;
+    }): () => Promise<void | undefined>;
+    dispose(): void;
+    private validateHeight;
+    private post;
+    private createRequest;
+}
+
 export declare type PlaygroundView = 'runtime' | 'files';
 
 export declare type PlaygroundViewport = 'auto' | number | [width: number, height: number];
@@ -188,6 +226,18 @@ export declare interface PlaygroundViewsProps {
     activeView: PlaygroundView;
 }
 
+export declare interface PlaygroundWindow extends Window {
+    $docsPlayground: PlaygroundService;
+}
+
+export declare const PREVIEW_SCROLL_CONTENT_CLASS = "docs-playground-preview-scroll__content";
+
+export declare const PREVIEW_SCROLL_HTML_CLASS = "docs-playground-preview-scroll";
+
+export declare const PREVIEW_SCROLLER_USE_CODE: string;
+
+declare type PreviewVue = Pick<vue, 'getCurrentScope' | 'onScopeDispose' | 'watch' | 'toValue' | 'isRef'>;
+
 export declare const registerVueHighlight: (api?: HLJSApi) => HLJSApi;
 
 export declare const removePlaygroundImportMapOverride: (alias: string) => {