ngx-semantic 2.0.7-beta.2 → 2.1.0

package/types/ngx-semantic-modules-visibility.d.ts

@@ -0,0 +1,124 @@
+import * as i0 from '@angular/core';
+import { OnInit, AfterViewInit, OnDestroy, EventEmitter } from '@angular/core';
+import * as i1 from '@angular/common';
+
+/** Semantic UI Visibility `type` setting. */
+type SuiVisibilityType = false | 'image' | 'fixed';
+/** Scroll direction between checks. */
+type SuiVisibilityDirection = 'up' | 'down';
+/**
+ * Geometry snapshot passed to Visibility callbacks
+ * (Semantic UI `module.get.elementCalculations`).
+ */
+interface SuiVisibilityCalculations {
+    topVisible: boolean;
+    topPassed: boolean;
+    bottomVisible: boolean;
+    bottomPassed: boolean;
+    passing: boolean;
+    onScreen: boolean;
+    offScreen: boolean;
+    fits: boolean;
+    width: number;
+    height: number;
+    pixelsPassed: number;
+    percentagePassed: number;
+    direction: SuiVisibilityDirection;
+}
+/** Payload for `suiOnPassed` when a configured amount is crossed. */
+interface SuiVisibilityPassedEvent {
+    amount: string;
+    calculations: SuiVisibilityCalculations;
+}
+/** Keys used for `onPassed` (`'10%'`, `'200px'`, …). */
+type SuiVisibilityPassedConfig = Record<string, unknown> | string[];
+
+declare class SuiVisibilityDirective implements OnInit, AfterViewInit, OnDestroy {
+    private readonly document;
+    private readonly el;
+    private readonly renderer;
+    private readonly zone;
+    /** Semantic UI `once` — each condition fires once until `refresh()`. */
+    suiOnce: boolean;
+    /** Fire on every check while the condition holds. */
+    suiContinuous: boolean;
+    /** Scroll context (`window`, selector, or element). */
+    suiContext: 'window' | string | HTMLElement | null;
+    /** Alias of `suiContext` (sticky-style). Takes precedence when set. */
+    suiScrollContext: 'window' | string | HTMLElement | null;
+    suiOffset: number;
+    suiIncludeMargin: boolean;
+    suiInitialCheck: boolean;
+    suiObserveChanges: boolean;
+    /** Milliseconds to throttle scroll checks; `false` uses `requestAnimationFrame`. */
+    suiThrottle: number | false;
+    suiType: SuiVisibilityType;
+    suiPassed: SuiVisibilityPassedConfig | null;
+    suiZIndex: number;
+    readonly suiOnOnScreen: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnOffScreen: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnTopVisible: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnTopPassed: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnBottomVisible: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnBottomPassed: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnPassing: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnTopVisibleReverse: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnTopPassedReverse: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnBottomVisibleReverse: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnBottomPassedReverse: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnPassingReverse: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnUpdate: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnPassed: EventEmitter<SuiVisibilityPassedEvent>;
+    readonly suiOnRefresh: EventEmitter<void>;
+    readonly suiOnFixed: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnUnfixed: EventEmitter<SuiVisibilityCalculations>;
+    readonly suiOnLoad: EventEmitter<SuiVisibilityCalculations>;
+    lastCalculations: SuiVisibilityCalculations | null;
+    private readonly destroy$;
+    private readonly occurred;
+    private readonly previous;
+    private scrollEl;
+    private lastScrollTop;
+    private disabled;
+    private mutationObserver;
+    private refreshTimer;
+    private throttleTimer;
+    private rafId;
+    private imageLoaded;
+    private isFixed;
+    private placeholder;
+    private readonly emitters;
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /** Mirrors `visibility('refresh')` — clears occurred flags and rechecks. */
+    refresh(): void;
+    disable(): void;
+    enable(): void;
+    /** Mirrors `visibility('check')`. */
+    check(): void;
+    private bindListeners;
+    private scheduleCheck;
+    private scheduleRefresh;
+    private resolveScrollElement;
+    private readScrollTop;
+    private readCalculations;
+    private emitConditions;
+    private emitPassed;
+    private applyImageType;
+    private applyFixedType;
+    private fixElement;
+    private unfixElement;
+    private removePlaceholder;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SuiVisibilityDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<SuiVisibilityDirective, "[suiVisibility]", ["suiVisibility"], { "suiOnce": { "alias": "suiOnce"; "required": false; }; "suiContinuous": { "alias": "suiContinuous"; "required": false; }; "suiContext": { "alias": "suiContext"; "required": false; }; "suiScrollContext": { "alias": "suiScrollContext"; "required": false; }; "suiOffset": { "alias": "suiOffset"; "required": false; }; "suiIncludeMargin": { "alias": "suiIncludeMargin"; "required": false; }; "suiInitialCheck": { "alias": "suiInitialCheck"; "required": false; }; "suiObserveChanges": { "alias": "suiObserveChanges"; "required": false; }; "suiThrottle": { "alias": "suiThrottle"; "required": false; }; "suiType": { "alias": "suiType"; "required": false; }; "suiPassed": { "alias": "suiPassed"; "required": false; }; "suiZIndex": { "alias": "suiZIndex"; "required": false; }; }, { "suiOnOnScreen": "suiOnOnScreen"; "suiOnOffScreen": "suiOnOffScreen"; "suiOnTopVisible": "suiOnTopVisible"; "suiOnTopPassed": "suiOnTopPassed"; "suiOnBottomVisible": "suiOnBottomVisible"; "suiOnBottomPassed": "suiOnBottomPassed"; "suiOnPassing": "suiOnPassing"; "suiOnTopVisibleReverse": "suiOnTopVisibleReverse"; "suiOnTopPassedReverse": "suiOnTopPassedReverse"; "suiOnBottomVisibleReverse": "suiOnBottomVisibleReverse"; "suiOnBottomPassedReverse": "suiOnBottomPassedReverse"; "suiOnPassingReverse": "suiOnPassingReverse"; "suiOnUpdate": "suiOnUpdate"; "suiOnPassed": "suiOnPassed"; "suiOnRefresh": "suiOnRefresh"; "suiOnFixed": "suiOnFixed"; "suiOnUnfixed": "suiOnUnfixed"; "suiOnLoad": "suiOnLoad"; }, never, never, true, never>;
+}
+
+declare class SuiVisibilityModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SuiVisibilityModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SuiVisibilityModule, never, [typeof i1.CommonModule, typeof SuiVisibilityDirective], [typeof SuiVisibilityDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SuiVisibilityModule>;
+}
+
+export { SuiVisibilityDirective, SuiVisibilityModule };
+export type { SuiVisibilityCalculations, SuiVisibilityDirection, SuiVisibilityPassedConfig, SuiVisibilityPassedEvent, SuiVisibilityType };

package/types/ngx-semantic.d.ts

@@ -42,10 +42,11 @@ import * as i40 from 'ngx-semantic/views/advertisement';
 import * as i41 from 'ngx-semantic/modules/sticky';
 import * as i42 from 'ngx-semantic/modules/shape';
 import * as i43 from 'ngx-semantic/modules/transition';
+import * as i44 from 'ngx-semantic/modules/visibility';
 
 declare class NgxSemanticModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxSemanticModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxSemanticModule, never, [typeof i1.SuiTabsModule, typeof i2.SuiFlagModule, typeof i3.SuiIconModule, typeof i4.SuiListModule, typeof i5.SuiRailModule, typeof i6.SuiGridModule, typeof i7.SuiFormModule, typeof i8.SuiMenuModule, typeof i9.SuiCardModule, typeof i10.SuiImageModule, typeof i11.SuiInputModule, typeof i12.SuiItemsModule, typeof i13.SuiLabelModule, typeof i14.SuiStepsModule, typeof i15.SuiTableModule, typeof i16.SuiPopupModule, typeof i17.SuiEmbedModule, typeof i18.SuiModalModule, typeof i19.SuiLoaderModule, typeof i20.SuiDimmerModule, typeof i21.SuiHeaderModule, typeof i22.SuiButtonModule, typeof i23.SuiRevealModule, typeof i24.SuiRatingModule, typeof i25.SuiSelectModule, typeof i26.SuiSearchModule, typeof i27.SuiMessageModule, typeof i28.SuiDividerModule, typeof i29.SuiCommentModule, typeof i30.SuiSegmentModule, typeof i31.SuiSidebarModule, typeof i32.SuiProgressModule, typeof i33.SuiDropdownModule, typeof i34.SuiCheckboxModule, typeof i35.SuiStatisticModule, typeof i36.SuiAccordionModule, typeof i37.SuiContainerModule, typeof i38.SuiBreadcrumbModule, typeof i39.SuiPlaceholderModule, typeof i40.SuiAdvertisementModule, typeof i41.SuiStickyModule, typeof i42.SuiShapeModule, typeof i43.SuiTransitionModule], [typeof i1.SuiTabsModule, typeof i2.SuiFlagModule, typeof i3.SuiIconModule, typeof i4.SuiListModule, typeof i5.SuiRailModule, typeof i6.SuiGridModule, typeof i7.SuiFormModule, typeof i8.SuiMenuModule, typeof i9.SuiCardModule, typeof i10.SuiImageModule, typeof i11.SuiInputModule, typeof i12.SuiItemsModule, typeof i13.SuiLabelModule, typeof i14.SuiStepsModule, typeof i15.SuiTableModule, typeof i16.SuiPopupModule, typeof i17.SuiEmbedModule, typeof i18.SuiModalModule, typeof i19.SuiLoaderModule, typeof i20.SuiDimmerModule, typeof i21.SuiHeaderModule, typeof i22.SuiButtonModule, typeof i23.SuiRevealModule, typeof i24.SuiRatingModule, typeof i25.SuiSelectModule, typeof i26.SuiSearchModule, typeof i27.SuiMessageModule, typeof i28.SuiDividerModule, typeof i29.SuiCommentModule, typeof i30.SuiSegmentModule, typeof i31.SuiSidebarModule, typeof i32.SuiProgressModule, typeof i33.SuiDropdownModule, typeof i34.SuiCheckboxModule, typeof i35.SuiStatisticModule, typeof i36.SuiAccordionModule, typeof i37.SuiContainerModule, typeof i38.SuiBreadcrumbModule, typeof i39.SuiPlaceholderModule, typeof i40.SuiAdvertisementModule, typeof i41.SuiStickyModule, typeof i42.SuiShapeModule, typeof i43.SuiTransitionModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxSemanticModule, never, [typeof i1.SuiTabsModule, typeof i2.SuiFlagModule, typeof i3.SuiIconModule, typeof i4.SuiListModule, typeof i5.SuiRailModule, typeof i6.SuiGridModule, typeof i7.SuiFormModule, typeof i8.SuiMenuModule, typeof i9.SuiCardModule, typeof i10.SuiImageModule, typeof i11.SuiInputModule, typeof i12.SuiItemsModule, typeof i13.SuiLabelModule, typeof i14.SuiStepsModule, typeof i15.SuiTableModule, typeof i16.SuiPopupModule, typeof i17.SuiEmbedModule, typeof i18.SuiModalModule, typeof i19.SuiLoaderModule, typeof i20.SuiDimmerModule, typeof i21.SuiHeaderModule, typeof i22.SuiButtonModule, typeof i23.SuiRevealModule, typeof i24.SuiRatingModule, typeof i25.SuiSelectModule, typeof i26.SuiSearchModule, typeof i27.SuiMessageModule, typeof i28.SuiDividerModule, typeof i29.SuiCommentModule, typeof i30.SuiSegmentModule, typeof i31.SuiSidebarModule, typeof i32.SuiProgressModule, typeof i33.SuiDropdownModule, typeof i34.SuiCheckboxModule, typeof i35.SuiStatisticModule, typeof i36.SuiAccordionModule, typeof i37.SuiContainerModule, typeof i38.SuiBreadcrumbModule, typeof i39.SuiPlaceholderModule, typeof i40.SuiAdvertisementModule, typeof i41.SuiStickyModule, typeof i42.SuiShapeModule, typeof i43.SuiTransitionModule, typeof i44.SuiVisibilityModule], [typeof i1.SuiTabsModule, typeof i2.SuiFlagModule, typeof i3.SuiIconModule, typeof i4.SuiListModule, typeof i5.SuiRailModule, typeof i6.SuiGridModule, typeof i7.SuiFormModule, typeof i8.SuiMenuModule, typeof i9.SuiCardModule, typeof i10.SuiImageModule, typeof i11.SuiInputModule, typeof i12.SuiItemsModule, typeof i13.SuiLabelModule, typeof i14.SuiStepsModule, typeof i15.SuiTableModule, typeof i16.SuiPopupModule, typeof i17.SuiEmbedModule, typeof i18.SuiModalModule, typeof i19.SuiLoaderModule, typeof i20.SuiDimmerModule, typeof i21.SuiHeaderModule, typeof i22.SuiButtonModule, typeof i23.SuiRevealModule, typeof i24.SuiRatingModule, typeof i25.SuiSelectModule, typeof i26.SuiSearchModule, typeof i27.SuiMessageModule, typeof i28.SuiDividerModule, typeof i29.SuiCommentModule, typeof i30.SuiSegmentModule, typeof i31.SuiSidebarModule, typeof i32.SuiProgressModule, typeof i33.SuiDropdownModule, typeof i34.SuiCheckboxModule, typeof i35.SuiStatisticModule, typeof i36.SuiAccordionModule, typeof i37.SuiContainerModule, typeof i38.SuiBreadcrumbModule, typeof i39.SuiPlaceholderModule, typeof i40.SuiAdvertisementModule, typeof i41.SuiStickyModule, typeof i42.SuiShapeModule, typeof i43.SuiTransitionModule, typeof i44.SuiVisibilityModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<NgxSemanticModule>;
 }