@ethlete/core 2.4.0 → 2.4.2

package/lib/directives/animated-overlay/animated-overlay.directive.d.ts

@@ -30,12 +30,17 @@ export declare class AnimatedOverlayDirective<T extends AnimatedOverlayComponent
     private _afterClosed;
     private readonly _isMounted$;
     /**
-     * The placement of the tooltip.
+     * The placement of the animated overlay.
      * @default 'auto'
      */
     placement: PopperPlacement;
     /**
-     * The offset of the tooltip.
+     * The allowed auto placements of the animated overlay.
+     * @see https://popper.js.org/docs/v2/modifiers/flip/#allowedautoplacements
+     */
+    allowedAutoPlacements?: PopperPlacement[];
+    /**
+     * The offset of the animated overlay.
      * @see https://popper.js.org/docs/v2/modifiers/offset/#offset-1
      */
     offset: OffsetOptions['offset'] | Readonly<OffsetOptions['offset']> | null;
@@ -65,5 +70,5 @@ export declare class AnimatedOverlayDirective<T extends AnimatedOverlayComponent
     _destroy(): void;
     _reposition(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AnimatedOverlayDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AnimatedOverlayDirective<any>, never, never, { "placement": { "alias": "placement"; "required": false; }; "offset": { "alias": "offset"; "required": false; }; "arrowPadding": { "alias": "arrowPadding"; "required": false; }; }, {}, never, never, true, [{ directive: typeof i1.ObserveResizeDirective; inputs: {}; outputs: {}; }]>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AnimatedOverlayDirective<any>, never, never, { "placement": { "alias": "placement"; "required": false; }; "allowedAutoPlacements": { "alias": "allowedAutoPlacements"; "required": false; }; "offset": { "alias": "offset"; "required": false; }; "arrowPadding": { "alias": "arrowPadding"; "required": false; }; }, {}, never, never, true, [{ directive: typeof i1.ObserveResizeDirective; inputs: {}; outputs: {}; }]>;
 }

package/lib/services/router-state.service.d.ts

@@ -1,16 +1,57 @@
 import { Data, Params } from '@angular/router';
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
-export declare const routerDisableScrollTop: (config?: {
+declare const ET_DISABLE_SCROLL_TOP: unique symbol;
+declare const ET_DISABLE_SCROLL_TOP_AS_RETURN_ROUTE: unique symbol;
+declare const ET_DISABLE_SCROLL_TOP_ON_PATH_PARAM_CHANGE: unique symbol;
+export interface RouterDisableScrollTopConfig {
+    /**
+     * Whether to disable scroll to top ONLY when navigating back to this route.
+     * @default false
+     */
     asReturnRoute?: boolean;
-}) => {
-    disableScrollTop: boolean;
-    disableScrollTopAsReturnRoute?: undefined;
+    /**
+     * Whether to disable scroll to top when a path param changes.
+     * @default false
+     */
+    onPathParamChange?: boolean;
+}
+export declare const routerDisableScrollTop: (config?: RouterDisableScrollTopConfig) => {
+    [ET_DISABLE_SCROLL_TOP_ON_PATH_PARAM_CHANGE]?: boolean | undefined;
+    [ET_DISABLE_SCROLL_TOP]: boolean;
 } | {
-    disableScrollTopAsReturnRoute: boolean;
-    disableScrollTop?: undefined;
+    [ET_DISABLE_SCROLL_TOP_ON_PATH_PARAM_CHANGE]?: boolean | undefined;
+    [ET_DISABLE_SCROLL_TOP_AS_RETURN_ROUTE]: boolean;
 };
 export declare const ET_PROPERTY_REMOVED: unique symbol;
+export interface ScrollEnhancementsConfig {
+    /**
+     * The scrollable container.
+     * @default document.documentElement
+     */
+    scrollElement?: HTMLElement;
+    /**
+     * A list of query params that should trigger a scroll to top.
+     * @default []
+     * @example ['page'] // will scroll to top when the page query param changes
+     */
+    queryParamTriggerList?: string[];
+    /**
+     * Config for fragment scrolling.
+     */
+    fragment?: {
+        /**
+         * Enable fragment scrolling (scroll to element with id)
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * Whether to use smooth scrolling or not.
+         * @default false
+         */
+        smooth?: boolean;
+    };
+}
 export declare class RouterStateService {
     private _isScrollTopOnNavigationEnabled;
     private readonly _router;
@@ -46,14 +87,7 @@ export declare class RouterStateService {
     get queryParamChanges$(): Observable<Partial<Params>>;
     get pathParamChanges$(): Observable<Partial<Params>>;
     constructor();
-    enableScrollEnhancements(config?: {
-        scrollElement?: HTMLElement;
-        queryParamTriggerList?: string[];
-        fragment?: {
-            enabled?: boolean;
-            smooth?: boolean;
-        };
-    }): void;
+    enableScrollEnhancements(config?: ScrollEnhancementsConfig): void;
     selectQueryParam<T = string | undefined>(key: string): Observable<T>;
     selectPathParam<T = string | undefined>(key: string): Observable<T>;
     selectData<T = unknown>(key: string): Observable<T>;
@@ -61,3 +95,4 @@ export declare class RouterStateService {
     static ɵfac: i0.ɵɵFactoryDeclaration<RouterStateService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<RouterStateService>;
 }
+export {};

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@ethlete/core",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "dependencies": {
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
     "@angular/common": "^15.2.1 || ^16.0.0",
     "@angular/core": "^15.2.1 || ^16.0.0",
-    "@angular/platform-browser": "16.0.2",
+    "@angular/platform-browser": "16.0.4",
     "@ethlete/types": "1.1.1",
     "rxjs": "7.8.1",
-    "@angular/cdk": "16.0.1",
-    "@popperjs/core": "2.11.7",
-    "@angular/router": "16.0.2",
-    "@angular/forms": "16.0.2"
+    "@angular/cdk": "16.0.3",
+    "@popperjs/core": "2.11.8",
+    "@angular/router": "16.0.4",
+    "@angular/forms": "16.0.4"
   },
   "module": "fesm2022/ethlete-core.mjs",
   "typings": "index.d.ts",