@skyux/core 14.0.0-alpha.7 → 14.0.0-alpha.9

package/fesm2022/skyux-core.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { NgModule, Injectable, inject, RendererFactory2, NgZone, DOCUMENT, EventEmitter, Output, Input, Directive, ElementRef, input, output, signal, effect, ChangeDetectionStrategy, Component, provideEnvironmentInitializer, DestroyRef, EnvironmentInjector, createEnvironmentInjector, createComponent, ChangeDetectorRef, ViewContainerRef, ViewChild, InjectionToken, Optional, Inject, ApplicationRef, afterNextRender, Injector, Pipe, HostBinding, Renderer2, HostListener } from '@angular/core';
+import { NgModule, Injectable, inject, RendererFactory2, NgZone, DOCUMENT, EventEmitter, Output, Input, Directive, effect, ElementRef, input, output, signal, DestroyRef, ChangeDetectionStrategy, Component, provideEnvironmentInitializer, EnvironmentInjector, createEnvironmentInjector, createComponent, ChangeDetectorRef, ViewContainerRef, ViewChild, InjectionToken, Optional, Inject, ApplicationRef, afterNextRender, Injector, Pipe, HostBinding, Renderer2, HostListener } from '@angular/core';
 import { Subject, Subscription, ReplaySubject, fromEvent, of, Observable, filter, map, distinctUntilChanged, shareReplay, observeOn, animationFrameScheduler, takeUntil as takeUntil$1, BehaviorSubject, combineLatestWith, switchMap, concat, debounceTime as debounceTime$1 } from 'rxjs';
 import { takeUntil, debounceTime, take } from 'rxjs/operators';
 import { ViewportRuler } from '@angular/cdk/overlay';
@@ -1054,80 +1054,112 @@ function _skyAnimationsDisabled() {
     return inject(DOCUMENT).body.classList.contains(SKY_ANIMATIONS_DISABLED_CLASS_NAME);
 }
 
+/**
+ * Mimics a CSS motion end event (`animationend`/`transitionend`) when
+ * CSS motion is disabled.
+ *
+ * Registers an effect that watches the provided trigger signal and, after the
+ * first change, emits on a microtask when the host element is visible. This
+ * preserves async timing that callers expect from real motion end events.
+ */
+function mimicCssMotionEvent(elementRef, destroyRef, triggerSignal, output) {
+    const el = elementRef.nativeElement;
+    let destroyed = false;
+    let initialized = false;
+    destroyRef.onDestroy(() => {
+        destroyed = true;
+    });
+    effect(() => {
+        triggerSignal();
+        // CSS animation/transition events do not fire when the element is `display: none`.
+        if (initialized && getComputedStyle(el).display !== 'none') {
+            // Defer the emit to a microtask so it fires after the current
+            // change detection pass, matching real transition timing.
+            queueMicrotask(() => {
+                if (!destroyed) {
+                    output.emit();
+                }
+            });
+        }
+        initialized = true;
+    });
+}
+
 /**
  * @internal
  *
  * Listens for CSS `transitionend` events on the host element and emits
  * a `transitionEnd` output when the tracked CSS property finishes
  * transitioning. When animations are globally disabled, the output
- * emits synchronously whenever the `transitionTrigger` input changes.
+ * emits via a microtask whenever the `transitionTrigger` input changes.
  *
- * Consumers **must** call `cssPropertyToTrack()` to specify which CSS
- * property to monitor before any transition occurs on the host element.
+ * The CSS property to monitor can be set via the `transitionPropertyToTrack`
+ * input (for template usage) or by calling `setPropertyToTrack()`
+ * (for `hostDirectives` usage).
  */
-class _SkyAnimationTransitionHandlerDirective {
+class _SkyTransitionEndHandlerDirective {
     #elementRef;
-    #propertyName;
+    #propertyNameOverride;
     constructor() {
         this.#elementRef = inject((ElementRef));
         /**
          * Drives the CSS transition on the host element. When the value
          * changes and animations are enabled, a CSS transition runs and
          * `transitionEnd` emits on completion. When animations are
-         * disabled, `transitionEnd` emits synchronously instead.
+         * disabled, `transitionEnd` emits via a microtask instead.
          */
         this.transitionTrigger = input.required(...(ngDevMode ? [{ debugName: "transitionTrigger" }] : []));
+        /**
+         * The CSS property name to monitor for `transitionend` events
+         * (e.g. `'opacity'`, `'transform'`). Can be set declaratively in
+         * templates.
+         */
+        this.transitionPropertyToTrack = input(...(ngDevMode ? [undefined, { debugName: "transitionPropertyToTrack" }] : []));
         /**
          * Emits when the tracked CSS property's `transitionend` event fires
-         * on the host element, or synchronously when animations are disabled.
+         * on the host element, or via a microtask when animations are disabled.
          */
         this.transitionEnd = output();
-        this.#propertyName = signal(undefined, ...(ngDevMode ? [{ debugName: "#propertyName" }] : []));
+        this.#propertyNameOverride = signal(undefined, ...(ngDevMode ? [{ debugName: "#propertyNameOverride" }] : []));
         if (_skyAnimationsDisabled()) {
-            let initialized = false;
-            effect(() => {
-                this.transitionTrigger();
-                if (initialized) {
-                    this.transitionEnd.emit();
-                }
-                initialized = true;
-            });
+            mimicCssMotionEvent(this.#elementRef, inject(DestroyRef), this.transitionTrigger, this.transitionEnd);
         }
     }
     /**
      * Sets the CSS property name to monitor for `transitionend` events
-     * (e.g. `'opacity'`, `'max-height'`). This must be called before a
-     * transition occurs; otherwise an error is thrown when the host
-     * element's `transitionend` event fires.
+     * programmatically. Use this when applying the directive via
+     * `hostDirectives`.
      */
-    cssPropertyToTrack(propertyName) {
-        this.#propertyName.set(propertyName);
+    setPropertyToTrack(propertyName) {
+        this.#propertyNameOverride.set(propertyName);
     }
     onTransitionEnd(evt) {
         if (evt.target !== this.#elementRef.nativeElement) {
             return;
         }
-        if (!this.#propertyName()) {
-            throw new Error(`SkyAnimationTransitionHandler: No CSS property specified for transition tracking on element ` +
+        const propertyName = this.transitionPropertyToTrack() ?? this.#propertyNameOverride();
+        if (!propertyName) {
+            throw new Error(`SkyTransitionEndHandler: No CSS property specified for transition tracking on element ` +
                 `'<${this.#elementRef.nativeElement.tagName.toLowerCase()}>'. ` +
-                `Call 'cssPropertyToTrack()' with a valid CSS property name before a transition occurs.`);
+                `Set the 'transitionPropertyToTrack' input or call 'setPropertyToTrack()' with a valid CSS property name before a transition occurs.`);
         }
-        if (evt.propertyName === this.#propertyName()) {
+        if (evt.propertyName === propertyName) {
             this.transitionEnd.emit();
             evt.stopPropagation();
         }
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyAnimationTransitionHandlerDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive }); }
-    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "17.1.0", version: "21.2.0", type: _SkyAnimationTransitionHandlerDirective, isStandalone: true, inputs: { transitionTrigger: { classPropertyName: "transitionTrigger", publicName: "transitionTrigger", isSignal: true, isRequired: true, transformFunction: null } }, outputs: { transitionEnd: "transitionEnd" }, host: { listeners: { "transitionend": "onTransitionEnd($event)" } }, ngImport: i0 }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyTransitionEndHandlerDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive }); }
+    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "17.1.0", version: "21.2.0", type: _SkyTransitionEndHandlerDirective, isStandalone: true, selector: "[skyTransitionEndHandler]", inputs: { transitionTrigger: { classPropertyName: "transitionTrigger", publicName: "transitionTrigger", isSignal: true, isRequired: true, transformFunction: null }, transitionPropertyToTrack: { classPropertyName: "transitionPropertyToTrack", publicName: "transitionPropertyToTrack", isSignal: true, isRequired: false, transformFunction: null } }, outputs: { transitionEnd: "transitionEnd" }, host: { listeners: { "transitionend": "onTransitionEnd($event)" } }, ngImport: i0 }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyAnimationTransitionHandlerDirective, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyTransitionEndHandlerDirective, decorators: [{
             type: Directive,
             args: [{
+                    selector: '[skyTransitionEndHandler]',
                     host: {
                         '(transitionend)': 'onTransitionEnd($event)',
                     },
                 }]
-        }], ctorParameters: () => [], propDecorators: { transitionTrigger: [{ type: i0.Input, args: [{ isSignal: true, alias: "transitionTrigger", required: true }] }], transitionEnd: [{ type: i0.Output, args: ["transitionEnd"] }] } });
+        }], ctorParameters: () => [], propDecorators: { transitionTrigger: [{ type: i0.Input, args: [{ isSignal: true, alias: "transitionTrigger", required: true }] }], transitionPropertyToTrack: [{ type: i0.Input, args: [{ isSignal: true, alias: "transitionPropertyToTrack", required: false }] }], transitionEnd: [{ type: i0.Output, args: ["transitionEnd"] }] } });
 
 /**
  * @internal
@@ -1138,10 +1170,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
 class _SkyAnimationSlideComponent {
     constructor() {
         this.opened = input.required(...(ngDevMode ? [{ debugName: "opened" }] : []));
-        inject(_SkyAnimationTransitionHandlerDirective).cssPropertyToTrack('visibility');
+        inject(_SkyTransitionEndHandlerDirective).setPropertyToTrack('visibility');
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyAnimationSlideComponent, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
-    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.1.0", version: "21.2.0", type: _SkyAnimationSlideComponent, isStandalone: true, selector: "sky-animation-slide", inputs: { opened: { classPropertyName: "opened", publicName: "opened", isSignal: true, isRequired: true, transformFunction: null } }, host: { properties: { "class.sky-animation-slide-in": "!opened()", "class.sky-animation-slide-out": "opened()" } }, hostDirectives: [{ directive: _SkyAnimationTransitionHandlerDirective, inputs: ["transitionTrigger", "opened"], outputs: ["transitionEnd", "transitionEnd"] }], ngImport: i0, template: '<div class="sky-animation-slide-content"><ng-content /></div>', isInline: true, styles: [":host{display:grid;grid-template-rows:0fr;overflow:hidden;transition-property:grid-template-rows,visibility;transition-duration:var(--sky-transition-time-short);transition-timing-function:ease-in}:host.sky-animation-slide-in{grid-template-rows:0fr;visibility:hidden}:host.sky-animation-slide-out{grid-template-rows:1fr;visibility:visible}:host>.sky-animation-slide-content{min-height:0;overflow:hidden}\n"], changeDetection: i0.ChangeDetectionStrategy.OnPush }); }
+    static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.1.0", version: "21.2.0", type: _SkyAnimationSlideComponent, isStandalone: true, selector: "sky-animation-slide", inputs: { opened: { classPropertyName: "opened", publicName: "opened", isSignal: true, isRequired: true, transformFunction: null } }, host: { properties: { "class.sky-animation-slide-in": "!opened()", "class.sky-animation-slide-out": "opened()" } }, hostDirectives: [{ directive: _SkyTransitionEndHandlerDirective, inputs: ["transitionTrigger", "opened"], outputs: ["transitionEnd", "transitionEnd"] }], ngImport: i0, template: '<div class="sky-animation-slide-content"><ng-content /></div>', isInline: true, styles: [":host{display:grid;grid-template-rows:0fr;overflow:hidden;transition-property:grid-template-rows,visibility;transition-duration:var(--sky-transition-time-short);transition-timing-function:ease-in}:host.sky-animation-slide-in{grid-template-rows:0fr;visibility:hidden}:host.sky-animation-slide-out{grid-template-rows:1fr;visibility:visible}:host>.sky-animation-slide-content{min-height:0;overflow:hidden}\n"], changeDetection: i0.ChangeDetectionStrategy.OnPush }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImport: i0, type: _SkyAnimationSlideComponent, decorators: [{
             type: Component,
@@ -1150,7 +1182,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.0", ngImpor
                         '[class.sky-animation-slide-out]': 'opened()',
                     }, hostDirectives: [
                         {
-                            directive: _SkyAnimationTransitionHandlerDirective,
+                            directive: _SkyTransitionEndHandlerDirective,
                             inputs: ['transitionTrigger: opened'],
                             outputs: ['transitionEnd'],
                         },
@@ -4872,11 +4904,11 @@ class Version {
 /**
  * Represents the version of @skyux/core.
  */
-const VERSION = new Version('14.0.0-alpha.7');
+const VERSION = new Version('14.0.0-alpha.9');
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { NumericOptions, SKY_BREAKPOINTS, SKY_BREAKPOINT_OBSERVER, SKY_HELP_GLOBAL_OPTIONS, SKY_LOG_LEVEL, SKY_STACKING_CONTEXT, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyContainerBreakpointObserver, SkyContentInfoProvider, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDefaultInputProvider, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLegacyService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyFileReaderService, SkyHelpService, SkyIdModule, SkyIdService, SkyLayoutHostDirective, SkyLayoutHostService, SkyLiveAnnouncerService, SkyLogLevel, SkyLogModule, SkyLogService, SkyMediaBreakpointObserver, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyMutationObserverService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayLegacyService, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyResponsiveHostDirective, SkyScreenReaderLabelDirective, SkyScrollShadowDirective, SkyScrollableHostService, SkyTrimModule, SkyUIConfigService, SkyViewkeeper, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, VERSION, _SkyAnimationSlideComponent, _SkyAnimationTransitionHandlerDirective, provideNoopSkyAnimations, provideSkyBreakpointObserver, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3, SkyTrimDirective as λ4 };
+export { NumericOptions, SKY_BREAKPOINTS, SKY_BREAKPOINT_OBSERVER, SKY_HELP_GLOBAL_OPTIONS, SKY_LOG_LEVEL, SKY_STACKING_CONTEXT, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyContainerBreakpointObserver, SkyContentInfoProvider, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDefaultInputProvider, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLegacyService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyFileReaderService, SkyHelpService, SkyIdModule, SkyIdService, SkyLayoutHostDirective, SkyLayoutHostService, SkyLiveAnnouncerService, SkyLogLevel, SkyLogModule, SkyLogService, SkyMediaBreakpointObserver, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyMutationObserverService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayLegacyService, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyResponsiveHostDirective, SkyScreenReaderLabelDirective, SkyScrollShadowDirective, SkyScrollableHostService, SkyTrimModule, SkyUIConfigService, SkyViewkeeper, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, VERSION, _SkyAnimationSlideComponent, _SkyTransitionEndHandlerDirective, provideNoopSkyAnimations, provideSkyBreakpointObserver, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3, SkyTrimDirective as λ4 };
 //# sourceMappingURL=skyux-core.mjs.map