@ethlete/cdk 4.34.1 → 4.35.0

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

@@ -3,7 +3,7 @@ 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'> & {
+export type CreateOverlayHandlerConfig<T, D = 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  */
@@ -18,13 +18,18 @@ export type OverlayHandler<T, D = unknown, R = unknown> = {
      * Returns the typed overlay ref.
      * @throws Error if the overlay ref gets accessed outside of the overlay component or templateRef
      */
-    getOverlayRef: () => OverlayRef<T, R>;
+    injectOverlayRef: () => OverlayRef<T, R>;
+    /**
+     * Returns the overlay data.
+     * @throws Error if the overlay data gets accessed outside of the overlay component or templateRef
+     */
+    injectOverlayData: () => D;
 };
 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: <TComponent, TOverlayData = unknown, TOverlayResult = unknown>(rootConfig: CreateOverlayHandlerConfig<TComponent, TOverlayData, TOverlayResult>) => (innerConfig?: CreateOverlayHandlerInnerConfig<TOverlayResult>) => OverlayHandler<TComponent, TOverlayData, TOverlayResult>;
+export declare const createOverlayHandler: <TComponent, TOverlayData = unknown, TOverlayResult = unknown>(rootConfig: CreateOverlayHandlerConfig<TComponent, TOverlayData>) => (innerConfig?: CreateOverlayHandlerInnerConfig<TOverlayResult>) => OverlayHandler<TComponent, TOverlayData, TOverlayResult>;
 export type OverlayHandlerWithQueryParamLifecycle<Q = string> = {
     /** Open the overlay using the provided query param value  */
     open: (queryParamValue: Q) => void;
@@ -39,6 +44,7 @@ export type CreateOverlayHandlerWithQueryParamLifecycleConfig<T> = Omit<OverlayC
     /** The query param key to be used for the overlay  */
     queryParamKey: string;
 };
+export declare const OVERLAY_QUERY_PARAM_INPUT_NAME = "overlayQueryParam";
 /**
  * This handler will automatically open the overlay when the query param is present.
  * The overlay can contain a required input with the name `overlayQueryParam` to receive the query param value.
@@ -48,4 +54,7 @@ export type CreateOverlayHandlerWithQueryParamLifecycleConfig<T> = Omit<OverlayC
  *
  * To open the overlay either use the `OverlayHandlerLinkDirective` or call the `.open` method of the returned handler.
  */
-export declare const createOverlayHandlerWithQueryParamLifecycle: <TComponent, TQueryParam extends string = string, TResult = unknown>(config: CreateOverlayHandlerWithQueryParamLifecycleConfig<TComponent>) => (innerConfig?: CreateOverlayHandlerInnerConfig<TResult>) => OverlayHandlerWithQueryParamLifecycle<TQueryParam>;
+export declare const createOverlayHandlerWithQueryParamLifecycle: <TComponent, TQueryParam extends string = string, TResult = unknown>(config: CreateOverlayHandlerWithQueryParamLifecycleConfig<TComponent>) => {
+    (innerConfig?: CreateOverlayHandlerInnerConfig<TResult>): OverlayHandlerWithQueryParamLifecycle<TQueryParam>;
+    injectOverlayRef(): OverlayRef<TComponent, TResult>;
+};

package/package.json

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