@cocoar/ui-overlay 0.1.0-beta.79 → 0.1.0-beta.82

package/types/cocoar-ui-overlay.d.ts

@@ -137,50 +137,6 @@ declare const COAR_OVERLAY_DEFAULTS: {
         readonly strategy: "body";
     };
 };
-type ResolvedOverlaySpec<TInputs> = Required<Omit<OverlaySpec<TInputs>, 'content'>> & Pick<Required<OverlaySpec<TInputs>>, 'content'>;
-
-declare class ContentBuilder {
-    fromComponent<C>(component: Type<C>): ContentSpec<Partial<C>>;
-    fromTemplate<TCtx>(template: TemplateRef<TCtx>): ContentSpec<TCtx>;
-    fromText(): ContentSpec<{
-        text: string;
-    }>;
-}
-
-declare class OverlayBuilder {
-    private readonly draft;
-    constructor(seed?: OverlaySpec<unknown>);
-    backdrop(cfg?: BackdropSpec | 'none' | 'modal'): this;
-    anchor(cfg: AnchorSpec): this;
-    position(cfg: PositionSpec): this;
-    size(cfg: SizeSpec): this;
-    scroll(cfg: ScrollSpec): this;
-    dismiss(cfg: DismissSpec): this;
-    focus(cfg: FocusSpec): this;
-    a11y(cfg: A11ySpec): this;
-    attachment(cfg: AttachmentSpec): this;
-    content(fn: (c: ContentBuilder) => ContentSpec<unknown>): this;
-    freeze<TInputs = void>(): OverlaySpec<TInputs>;
-}
-
-type OverlayPreset = (b: OverlayBuilder) => void;
-declare const coarTooltipPreset: OverlayPreset;
-declare const coarModalPreset: OverlayPreset;
-declare const coarMenuPreset: OverlayPreset;
-/**
- * Menu preset for hover-driven menus (context menus, cascading flyouts).
- *
- * Enables hoverTree dismissal so a parent overlay stays open while the pointer
- * is inside any child overlay opened via openChild().
- */
-declare const coarHoverMenuPreset: OverlayPreset;
-
-declare class CoarOverlay {
-    static define<TInputs = void>(fn: (b: OverlayBuilder) => void, ...presets: readonly OverlayPreset[]): OverlaySpec<TInputs>;
-    static fork<TInputs>(base: OverlaySpec<TInputs>, fn: (b: OverlayBuilder) => void): OverlaySpec<TInputs>;
-}
-/** Alias kept for spec parity (`Overlay.define(...)`). */
-declare const Overlay: typeof CoarOverlay;
 
 interface OverlayRef {
     close(result?: unknown): void;
@@ -201,17 +157,13 @@ interface OverlayRef {
 }
 
 interface OverlayOpenOptions {
-    /**
-     * Optional parent overlay. Used for menus/submenus so the service can keep trees consistent
-     * (e.g. closing a parent closes its children).
-     */
-    parent?: OverlayRef;
-    /**
-     * If true, closes all sibling overlays (other children of the same parent) when this overlay opens.
-     * Useful for menus where only one submenu should be visible at a time.
-     */
     closeSiblings?: boolean;
 }
+type OverlaySettings<TInputs> = Omit<OverlaySpec<TInputs>, 'content'>;
+type UnwrapInputSignal<T> = T extends i0.InputSignal<infer V> ? V : T;
+type ComponentInputs<C> = {
+    [K in keyof C]?: UnwrapInputSignal<C[K]>;
+};
 declare class CoarOverlayService {
     private readonly appRef;
     private readonly environmentInjector;
@@ -220,10 +172,20 @@ declare class CoarOverlayService {
     private globalListenersInstalled;
     private readonly onDocumentPointerDown;
     private readonly onDocumentKeyDown;
-    open<TInputs>(spec: OverlaySpec<TInputs>, inputs: TInputs, options?: OverlayOpenOptions): OverlayRef;
-    openChild<TInputs>(parent: OverlayRef, spec: OverlaySpec<TInputs>, inputs: TInputs, options?: {
-        closeSiblings?: boolean;
+    openTemplate<TCtx>(template: TemplateRef<TCtx>, settings: OverlaySettings<TCtx>, inputs: TCtx): OverlayRef;
+    openComponent<C>(component: Type<C>, settings: OverlaySettings<ComponentInputs<C>>, inputs: ComponentInputs<C>): OverlayRef;
+    openText(settings: OverlaySettings<{
+        text: string;
+    }>, inputs: {
+        text: string;
     }): OverlayRef;
+    openTemplateAsChild<TCtx>(parent: OverlayRef, template: TemplateRef<TCtx>, settings: OverlaySettings<TCtx>, inputs: TCtx, options?: OverlayOpenOptions): OverlayRef;
+    openComponentAsChild<C>(parent: OverlayRef, component: Type<C>, settings: OverlaySettings<ComponentInputs<C>>, inputs: ComponentInputs<C>, options?: OverlayOpenOptions): OverlayRef;
+    openTextAsChild(parent: OverlayRef, settings: OverlaySettings<{
+        text: string;
+    }>, inputs: {
+        text: string;
+    }, options?: OverlayOpenOptions): OverlayRef;
     closeAll(): void;
     private resolveSpec;
     private applySpecResolvers;
@@ -237,46 +199,79 @@ declare class CoarOverlayService {
     private getTopmostDismissableOverlay;
     private getTopmostFocusTrappingOverlay;
     private mergeInputs;
-    private renderContent;
     static ɵfac: i0.ɵɵFactoryDeclaration<CoarOverlayService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<CoarOverlayService>;
 }
 
-interface ViewportRect {
-    readonly width: number;
-    readonly height: number;
+interface OverlayChildOpenOptions {
+    closeSiblings?: boolean;
 }
-interface Rect {
-    readonly left: number;
-    readonly top: number;
-    readonly right: number;
-    readonly bottom: number;
-    readonly width: number;
-    readonly height: number;
+interface TemplateOverlayOpener<TCtx> {
+    open(inputs: TCtx): OverlayRef;
+    openAsChild(parent: OverlayRef, inputs: TCtx, options?: OverlayChildOpenOptions): OverlayRef;
 }
-interface Point {
-    readonly x: number;
-    readonly y: number;
+interface ComponentOverlayOpener<C> {
+    open(inputs: ComponentInputs<C>): OverlayRef;
+    openAsChild(parent: OverlayRef, inputs: ComponentInputs<C>, options?: OverlayChildOpenOptions): OverlayRef;
 }
-interface OverlaySize {
-    readonly width: number;
-    readonly height: number;
+interface TextOverlayOpener {
+    open(inputs: {
+        text: string;
+    }): OverlayRef;
+    openAsChild(parent: OverlayRef, inputs: {
+        text: string;
+    }, options?: OverlayChildOpenOptions): OverlayRef;
 }
-interface OverlayCoordinates {
-    readonly left: number;
-    readonly top: number;
-    readonly placement: Placement;
+declare class CoarOverlayOpenBuilder {
+    private readonly service;
+    private readonly settings;
+    constructor(service: CoarOverlayService, settings?: OverlaySettings<unknown>);
+    fork(): CoarOverlayOpenBuilder;
+    backdrop(value: OverlaySettings<unknown>['backdrop']): CoarOverlayOpenBuilder;
+    anchor(value: OverlaySettings<unknown>['anchor']): CoarOverlayOpenBuilder;
+    position(value: OverlaySettings<unknown>['position']): CoarOverlayOpenBuilder;
+    size(value: OverlaySettings<unknown>['size']): CoarOverlayOpenBuilder;
+    scroll(value: OverlaySettings<unknown>['scroll']): CoarOverlayOpenBuilder;
+    dismiss(value: OverlaySettings<unknown>['dismiss']): CoarOverlayOpenBuilder;
+    focus(value: OverlaySettings<unknown>['focus']): CoarOverlayOpenBuilder;
+    a11y(value: OverlaySettings<unknown>['a11y']): CoarOverlayOpenBuilder;
+    attachment(value: OverlaySettings<unknown>['attachment']): CoarOverlayOpenBuilder;
+    /**
+     * Applies baseline settings, without overriding fields already set on this builder.
+     * Useful for applying a preset after you've already configured part of the builder.
+     */
+    withPreset(value: OverlaySettings<unknown>): CoarOverlayOpenBuilder;
+    fromTemplate<TCtx>(template: TemplateRef<TCtx>): TemplateOverlayOpener<TCtx>;
+    fromComponent<C>(component: Type<C>): ComponentOverlayOpener<C>;
+    fromText(): TextOverlayOpener;
 }
-declare function getViewportRect(): ViewportRect;
-declare function getContainerRect(container: HTMLElement): Rect;
-declare function rectFromDom(domRect: DOMRect): Rect;
-declare function getAnchorRect(anchor: AnchorSpec, viewport: ViewportRect): Rect;
-declare function rectFromPoint(point: Point, width: number, height: number): Rect;
-declare function rectFromVirtual(spec: Extract<AnchorSpec, {
-    kind: 'virtual';
-}>, viewport: ViewportRect): Rect;
-declare function getScrollParents(element: Element): Array<Element | Window>;
-declare function computeOverlayCoordinates(anchorRect: Rect, overlaySize: OverlaySize, position: PositionSpec, viewport: ViewportRect, boundaryRect?: Rect): OverlayCoordinates;
+/**
+ * Content-last overlay builder (configure shared overlay settings once).
+ *
+ * Intended usage:
+ *
+ * ```ts
+ * const overlay = createOverlayBuilder()
+ *   .anchor({ kind: 'element', element })
+ *   .position({ placement: 'bottom-start', offset: 4, flip: true, shift: true });
+ *
+ * overlay.fromTemplate(tpl).open({ $implicit: data });
+ * overlay.fromComponent(MyCmp).open({ text: 'Hello' });
+ * ```
+ *
+ * You can also provide initial settings:
+ *
+ * ```ts
+ * const overlay = createOverlayBuilder(coarMenuPreset);
+ * ```
+ */
+declare function createOverlayBuilder(): CoarOverlayOpenBuilder;
+declare function createOverlayBuilder(initial: OverlaySettings<unknown>): CoarOverlayOpenBuilder;
+
+declare const coarTooltipPreset: OverlaySettings<unknown>;
+declare const coarModalPreset: OverlaySettings<unknown>;
+declare const coarMenuPreset: OverlaySettings<unknown>;
+declare const coarHoverMenuPreset: OverlaySettings<unknown>;
 
 /**
  * The OverlayRef for the overlay currently rendering this content.
@@ -292,5 +287,5 @@ declare const COAR_OVERLAY_REF: InjectionToken<OverlayRef>;
  */
 declare const COAR_MENU_PARENT: InjectionToken<OverlayRef | null>;
 
-export { COAR_MENU_PARENT, COAR_OVERLAY_DEFAULTS, COAR_OVERLAY_REF, COAR_OVERLAY_SPEC_RESOLVERS, CoarOverlay, CoarOverlayService, ContentBuilder, Overlay, OverlayBuilder, CoarOverlayService as OverlayService, coarHoverMenuPreset, coarMenuPreset, coarModalPreset, coarTooltipPreset, computeOverlayCoordinates, getAnchorRect, getContainerRect, getScrollParents, getViewportRect, coarHoverMenuPreset as hoverMenuPreset, coarMenuPreset as menuPreset, coarModalPreset as modalPreset, rectFromDom, rectFromPoint, rectFromVirtual, coarTooltipPreset as tooltipPreset };
-export type { A11ySpec, AnchorSpec, AttachmentSpec, BackdropSpec, ContentSpec, DismissSpec, FocusSpec, OverlayCoordinates, OverlayOpenOptions, OverlayPreset, OverlayRef, OverlaySize, OverlaySpec, OverlaySpecResolver, Placement, Point, PositionSpec, Rect, ResolvedOverlaySpec, ScrollSpec, SizeSpec, ViewportRect };
+export { COAR_MENU_PARENT, COAR_OVERLAY_DEFAULTS, COAR_OVERLAY_REF, COAR_OVERLAY_SPEC_RESOLVERS, CoarOverlayOpenBuilder, coarHoverMenuPreset, coarMenuPreset, coarModalPreset, coarTooltipPreset, createOverlayBuilder };
+export type { A11ySpec, AnchorSpec, AttachmentSpec, BackdropSpec, ComponentOverlayOpener, DismissSpec, FocusSpec, OverlayChildOpenOptions, OverlayRef, OverlaySettings, OverlaySpec, OverlaySpecResolver, Placement, PositionSpec, ScrollSpec, SizeSpec, TemplateOverlayOpener, TextOverlayOpener };