@tumaet/apollon 4.8.0 → 4.9.0

package/dist/react/overlay/types.d.ts

@@ -0,0 +1,48 @@
+import { ReactNode, CSSProperties } from 'react';
+/**
+ * Where a control is anchored. The six React Flow `<Panel>` corners are
+ * screen-space and rendered through React Flow; `header`/`left-rail`/`right-rail`
+ * are library-owned bands; `on-canvas` pans/zooms with the diagram.
+ */
+export type OverlayRegion = "top-left" | "top-center" | "top-right" | "bottom-left" | "bottom-center" | "bottom-right" | "header" | "left-rail" | "right-rail" | "on-canvas";
+/** Regions that map directly onto a React Flow `<Panel position>`. */
+export declare const PANEL_REGIONS: readonly ["top-left", "top-center", "top-right", "bottom-left", "bottom-center", "bottom-right"];
+/** Every valid region — used to validate control registration at the API edge. */
+export declare const OVERLAY_REGIONS: readonly OverlayRegion[];
+/** One of the four edges a control can sit against / reserve room on. */
+export type OverlaySide = "top" | "right" | "bottom" | "left";
+/** Reserved room per side, in px. */
+export type Insets = Record<OverlaySide, number>;
+export declare const ZERO_INSETS: Insets;
+/**
+ * How much room a control reserves so the diagram "makes way" (fed into
+ * `fitView` padding, MapLibre-style). `"auto"` measures the control via the
+ * shared ResizeObserver on the region's dominant axis; an object mixes explicit
+ * px with per-side `"auto"` (e.g. `{ top: "auto" }`).
+ */
+export type InsetContribution = "auto" | Partial<Record<OverlaySide, number | "auto">>;
+export interface OverlayControlOptions {
+    /** Stable id. Re-adding the same id REPLACES (idempotent, StrictMode-safe). */
+    id: string;
+    /** Which band/corner the control is anchored in. */
+    region: OverlayRegion;
+    /** Reserve viewport room. Default: reserves nothing (the control floats). */
+    inset?: InsetContribution;
+    /** Stacking within a region; lower renders toward the region's anchor edge. */
+    order?: number;
+    /** When false the region frame stays pointer-transparent here too. Default true. */
+    interactive?: boolean;
+    /** Wraps the control in a `role="group"` with this aria-label. No focus
+     *  management is imposed. */
+    groupLabel?: string;
+    /** Hide without unregistering (reserves no inset while hidden). Default true. */
+    visible?: boolean;
+    /** Extra class on the control's wrapper element. */
+    className?: string;
+    /** Inline styles merged onto the control's wrapper element. */
+    style?: CSSProperties;
+}
+/** The public registration payload (options + renderer). */
+export type OverlayControlInput = OverlayControlOptions & {
+    render: () => ReactNode;
+};

package/dist/react/react.d.ts

@@ -2,3 +2,4 @@ export * from './index';
 export { Apollon, type ApollonProps } from './components/react/Apollon';
 export { ApollonProvider, useApollonEditor, useApollonEditorOrThrow, } from './components/react/context';
 export { useApollonSubscription } from './components/react/useApollonSubscription';
+export { ApollonControl, type ApollonControlProps, } from './components/react/ApollonControl';