@ansible-flow/designer 0.0.0-stage → 0.85.0

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import type { ThemeKind } from '@ansible-flow/core/theme';
+import type { DesignerTransport } from './transport';
+export type { ThemeKind } from '@ansible-flow/core/theme';
+export type { DesignerTransport } from './transport';
+/** A theme kind, or `auto`: light or dark as the browser prefers, and it follows a change. */
+export type ThemeChoice = ThemeKind | 'auto';
+export interface MountOptions {
+    /** How the designer talks to its host. */
+    transport: DesignerTransport;
+    /** Default `auto`. */
+    theme?: ThemeChoice;
+    /**
+     * The designer only shows and runs the flow (AFD-270), whatever the host's `config` says. The
+     * host must still refuse what a viewer may not send (`@ansible-flow/core/viewer`).
+     */
+    viewer?: boolean;
+}
+export interface MountedDesigner {
+    setTheme(theme: ThemeChoice): void;
+    /** Removes the designer from the element. The page's theme class and variables stay. */
+    unmount(): void;
+}
+/**
+ * Shows the designer in `el`. The designer is made to be the whole page, as it is in a VS Code
+ * webview: its stylesheet styles <body>, its keys are handled on the window and its menus open on
+ * <body>. Give it a page or an iframe of its own; `el` fills its parent.
+ */
+export declare function mount(el: HTMLElement, options: MountOptions): MountedDesigner;