@ethlete/cdk 4.30.0 → 4.31.0

package/lib/components/overlay/components/overlay/types/overlay.types.d.ts

@@ -2,6 +2,7 @@ import { Direction } from '@angular/cdk/bidi';
 import { PositionStrategy, ScrollStrategy } from '@angular/cdk/overlay';
 import { Injector, StaticProvider, ViewContainerRef } from '@angular/core';
 import { Breakpoint } from '@ethlete/core';
+import { EmptyObject } from '@ethlete/query';
 /** Options for where to set focus to automatically on overlay open */
 export type OverlayAutoFocusTarget = 'dialog' | 'first-tabbable' | 'first-heading';
 /** Valid ARIA roles for a overlay element. */
@@ -194,3 +195,11 @@ export interface OverlayConfig<D = unknown> {
      */
     origin?: HTMLElement | MouseEvent | TouchEvent | KeyboardEvent | PointerEvent;
 }
+/**
+ * Configuration utility type for overlays.
+ * To be used inside your overlay opener method as a param to be passed to the overlay.open method.
+ */
+export type OverlayConsumerConfig<D = void> = Omit<OverlayConfig<D>, 'positions' | 'data'> & MaybeOverlayConsumerConfigWithData<D>;
+export type MaybeOverlayConsumerConfigWithData<D> = D extends void ? EmptyObject : {
+    data: D;
+};

package/lib/components/overlay/components/overlay/utils/index.d.ts

@@ -1,5 +1,6 @@
 export * from './filter-overlay';
 export * from './overlay-config';
+export * from './overlay-handler';
 export * from './overlay-position-builder';
 export * from './overlay-ref';
 export * from './overlay-router';

package/lib/components/overlay/components/overlay/utils/overlay-handler.d.ts

@@ -0,0 +1,27 @@
+import { ComponentType } from '@angular/cdk/overlay';
+import { TemplateRef } from '@angular/core';
+import { OverlayBreakpointConfigEntry, OverlayConfig, OverlayConsumerConfig } from '../types';
+import { OverlayPositionBuilder } from './overlay-position-builder';
+import { OverlayRef } from './overlay-ref';
+export type CreateOverlayHandlerConfig<T, D = unknown, R = unknown> = Omit<OverlayConfig<D>, 'positions'> & {
+    /** The overlay component. Use either this or the `template` property  */
+    component?: ComponentType<T>;
+    /** The overlay template. Use either this or the `component` property  */
+    template?: TemplateRef<T>;
+    /** The overlay positions using the position builder provided via argument  */
+    positions: (builder: OverlayPositionBuilder) => OverlayBreakpointConfigEntry[];
+};
+export type OverlayHandler<T, D = unknown, R = unknown> = {
+    /** Open the overlay using a combination of the given configs  */
+    open: (config?: OverlayConsumerConfig<D>) => OverlayRef<T, R>;
+    /**
+     * Returns the typed overlay ref.
+     * @throws Error if the overlay ref gets accessed outside of the overlay component or templateRef
+     */
+    getOverlayRef: () => OverlayRef<T, R>;
+};
+export type CreateOverlayHandlerInnerConfig<R = unknown> = {
+    /** A callback function to be executed once the overlay has been closed */
+    afterClosed?: (result: R | null) => void;
+};
+export declare const createOverlayHandler: <T, D = unknown, R = unknown>(rootConfig: CreateOverlayHandlerConfig<T, D, R>) => (innerConfig?: CreateOverlayHandlerInnerConfig<R>) => OverlayHandler<T, D, R>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/cdk",
-  "version": "4.30.0",
+  "version": "4.31.0",
   "exports": {
     ".": {
       "css": "./src/lib/styles/index.css",