@gravionlabs/helix-core 22.0.0

package/types/gravionlabs-helix-core-scrollpanel.d.ts

@@ -0,0 +1,156 @@
+import { ScrollPanelPassThrough } from '@gravionlabs/helix-core/types/scrollpanel';
+export * from '@gravionlabs/helix-core/types/scrollpanel';
+import * as _angular_core from '@angular/core';
+import { ElementRef, TemplateRef, NgZone } from '@angular/core';
+import * as i2 from '@gravionlabs/helix-core/api';
+import { HelixTemplate } from '@gravionlabs/helix-core/api';
+import { BaseComponent } from '@gravionlabs/helix-core/basecomponent';
+import * as i1 from '@gravionlabs/helix-core/bind';
+import { Bind } from '@gravionlabs/helix-core/bind';
+import { Nullable } from '@gravionlabs/helix-core/ts-helpers';
+import { BaseStyle } from '@gravionlabs/helix-core/base';
+
+/**
+ *
+ * ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.
+ *
+ * [Live Demo](https://www.primeng.org/scrollpanel/)
+ *
+ * @module scrollpanelstyle
+ *
+ */
+declare enum ScrollPanelClasses {
+    /**
+     * Class name of the root element
+     */
+    root = "h-scrollpanel",
+    /**
+     * Class name of the content container element
+     */
+    contentContainer = "h-scrollpanel-content-container",
+    /**
+     * Class name of the content element
+     */
+    content = "h-scrollpanel-content",
+    /**
+     * Class name of the bar x element
+     */
+    barX = "h-scrollpanel-bar-x",
+    /**
+     * Class name of the bar y element
+     */
+    barY = "h-scrollpanel-bar-y"
+}
+declare class ScrollPanelStyle extends BaseStyle {
+    name: string;
+    style: string;
+    classes: {
+        root: string;
+        contentContainer: string;
+        content: string;
+        barX: string;
+        barY: string;
+    };
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollPanelStyle, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}
+interface ScrollPanelStyle extends BaseStyle {
+}
+
+/**
+ * ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.
+ * @group Components
+ */
+declare class ScrollPanel extends BaseComponent<ScrollPanelPassThrough> {
+    componentName: string;
+    $pcScrollPanel: ScrollPanel | undefined;
+    bindDirectiveInstance: Bind;
+    onAfterViewChecked(): void;
+    /**
+     * Style class of the component.
+     * @deprecated since v20.0.0, use `class` instead.
+     * @group Props
+     */
+    readonly styleClass: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Step factor to scroll the content while pressing the arrow keys.
+     * @group Props
+     */
+    readonly step: _angular_core.InputSignalWithTransform<number, unknown>;
+    readonly contentViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
+    readonly xBarViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
+    readonly yBarViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
+    /**
+     * Custom content template.
+     * @group Templates
+     */
+    readonly contentTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
+    readonly templates: _angular_core.Signal<readonly HelixTemplate[]>;
+    _contentTemplate: TemplateRef<void> | undefined;
+    scrollYRatio: number | undefined;
+    scrollXRatio: number | undefined;
+    timeoutFrame: any;
+    initialized: boolean;
+    lastPageY: number | undefined;
+    lastPageX: number | undefined;
+    isXBarClicked: boolean;
+    isYBarClicked: boolean;
+    lastScrollLeft: number;
+    lastScrollTop: number;
+    orientation: string;
+    timer: any;
+    contentId: string | undefined;
+    windowResizeListener: VoidFunction | null | undefined;
+    contentScrollListener: VoidFunction | null | undefined;
+    mouseEnterListener: VoidFunction | null | undefined;
+    xBarMouseDownListener: VoidFunction | null | undefined;
+    yBarMouseDownListener: VoidFunction | null | undefined;
+    documentMouseMoveListener: Nullable<(event?: any) => void>;
+    documentMouseUpListener: Nullable<(event?: any) => void>;
+    _componentStyle: ScrollPanelStyle;
+    zone: NgZone;
+    onInit(): void;
+    onAfterViewInit(): void;
+    onAfterContentInit(): void;
+    calculateContainerHeight(): void;
+    moveBar(): void;
+    onScroll(event: any): void;
+    onKeyDown(event: any): void;
+    onKeyUp(): void;
+    repeat(bar: any, step: any): void;
+    setTimer(bar: any, step: any): void;
+    clearTimer(): void;
+    bindDocumentMouseListeners(): void;
+    unbindDocumentMouseListeners(): void;
+    onYBarMouseDown(e: MouseEvent): void;
+    onXBarMouseDown(e: MouseEvent): void;
+    onDocumentMouseMove(e: MouseEvent): void;
+    onMouseMoveForXBar(e: MouseEvent): void;
+    onMouseMoveForYBar(e: MouseEvent): void;
+    /**
+     * Scrolls the top location to the given value.
+     * @param scrollTop
+     * @group Method
+     */
+    scrollTop(scrollTop: number): void;
+    onFocus(event: any): void;
+    onBlur(): void;
+    onDocumentMouseUp(e: Event): void;
+    requestAnimationFrame(f: VoidFunction): void;
+    unbindListeners(): void;
+    onDestroy(): void;
+    /**
+     * Refreshes the position and size of the scrollbar.
+     * @group Method
+     */
+    refresh(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollPanel, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ScrollPanel, "h-scroll-panel, h-scrollPanel, h-scrollpanel", never, { "styleClass": { "alias": "styleClass"; "required": false; "isSignal": true; }; "step": { "alias": "step"; "required": false; "isSignal": true; }; }, {}, ["contentTemplate", "templates"], ["*"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
+}
+declare class ScrollPanelModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollPanelModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<ScrollPanelModule, never, [typeof ScrollPanel, typeof i2.SharedModule, typeof i1.BindModule], [typeof ScrollPanel, typeof i2.SharedModule, typeof i1.BindModule]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<ScrollPanelModule>;
+}
+
+export { ScrollPanel, ScrollPanelClasses, ScrollPanelModule, ScrollPanelStyle };

package/types/gravionlabs-helix-core-scrolltop.d.ts

@@ -0,0 +1,155 @@
+import { ScrollTopPassThrough, ScrollTopIconTemplateContext } from '@gravionlabs/helix-core/types/scrolltop';
+export * from '@gravionlabs/helix-core/types/scrolltop';
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
+import { MotionOptions, MotionEvent } from '@gravionlabs/helix-core/uix/motion';
+import * as i2 from '@gravionlabs/helix-core/api';
+import { HelixTemplate } from '@gravionlabs/helix-core/api';
+import { BaseComponent } from '@gravionlabs/helix-core/basecomponent';
+import * as i1 from '@gravionlabs/helix-core/bind';
+import { Bind } from '@gravionlabs/helix-core/bind';
+import { ButtonProps } from '@gravionlabs/helix-core/button';
+import { BaseStyle } from '@gravionlabs/helix-core/base';
+
+/**
+ *
+ * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
+ *
+ * [Live Demo](https://www.primeng.org/scrolltop/)
+ *
+ * @module scrolltopstyle
+ *
+ */
+declare enum ScrollTopClasses {
+    /**
+     * Class name of the root element
+     */
+    root = "h-scrolltop",
+    /**
+     * Class name of the icon element
+     */
+    icon = "h-scrolltop-icon"
+}
+declare class ScrollTopStyle extends BaseStyle {
+    name: string;
+    style: string;
+    classes: {
+        root: ({ instance }: {
+            instance: any;
+        }) => (string | {
+            'h-scrolltop-sticky': boolean;
+        })[];
+        icon: string;
+    };
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollTopStyle, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}
+interface ScrollTopStyle extends BaseStyle {
+}
+
+/**
+ * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
+ * @group Components
+ */
+declare class ScrollTop extends BaseComponent<ScrollTopPassThrough> {
+    componentName: string;
+    $pcScrollTop: ScrollTop | undefined;
+    bindDirectiveInstance: Bind;
+    onAfterViewChecked(): void;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    readonly styleClass: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    readonly style: _angular_core.InputSignal<{
+        [klass: string]: any;
+    } | null | undefined>;
+    /**
+     * Target of the ScrollTop.
+     * @group Props
+     */
+    readonly target: _angular_core.InputSignal<"window" | "parent" | undefined>;
+    /**
+     * Defines the threshold value of the vertical scroll position of the target to toggle the visibility.
+     * @group Props
+     */
+    readonly threshold: _angular_core.InputSignalWithTransform<number, unknown>;
+    /**
+     * Name of the icon or JSX.Element for icon.
+     * @group Props
+     */
+    readonly icon: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Defines the scrolling behavior, "smooth" adds an animation and "auto" scrolls with a jump.
+     * @group Props
+     */
+    readonly behavior: _angular_core.InputSignal<"auto" | "smooth" | undefined>;
+    /**
+     * A string value used to determine the display transition options.
+     * @group Props
+     * @deprecated since v21.0.0. Use `motionOptions` instead.
+     */
+    readonly showTransitionOptions: _angular_core.InputSignal<string>;
+    /**
+     * A string value used to determine the hiding transition options.
+     * @group Props
+     * @deprecated since v21.0.0. Use `motionOptions` instead.
+     */
+    readonly hideTransitionOptions: _angular_core.InputSignal<string>;
+    /**
+     * The motion options.
+     * @group Props
+     */
+    motionOptions: _angular_core.InputSignal<MotionOptions | undefined>;
+    computedMotionOptions: _angular_core.Signal<MotionOptions>;
+    /**
+     * Establishes a string value that labels the scroll-top button.
+     * @group Props
+     */
+    readonly buttonAriaLabel: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Used to pass all properties of the ButtonProps to the Button component.
+     * @group Props
+     */
+    readonly buttonProps: _angular_core.InputSignal<ButtonProps>;
+    /**
+     * Custom icon template.
+     * @param {ScrollTopIconTemplateContext} context - icon context.
+     * @see {@link ScrollTopIconTemplateContext}
+     * @group Templates
+     */
+    readonly iconTemplate: _angular_core.Signal<TemplateRef<ScrollTopIconTemplateContext> | undefined>;
+    readonly templates: _angular_core.Signal<readonly HelixTemplate[]>;
+    _iconTemplate: TemplateRef<ScrollTopIconTemplateContext> | undefined;
+    documentScrollListener: VoidFunction | null | undefined;
+    parentScrollListener: VoidFunction | null | undefined;
+    visible: _angular_core.WritableSignal<boolean>;
+    render: _angular_core.WritableSignal<boolean>;
+    overlay: any;
+    _componentStyle: ScrollTopStyle;
+    onInit(): void;
+    onAfterContentInit(): void;
+    onClick(): void;
+    onBeforeEnter(event: MotionEvent): void;
+    onBeforeLeave(): void;
+    onAfterLeave(): void;
+    checkVisibility(scrollY: number): void;
+    bindParentScrollListener(): void;
+    bindDocumentScrollListener(): void;
+    unbindParentScrollListener(): void;
+    unbindDocumentScrollListener(): void;
+    onDestroy(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollTop, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ScrollTop, "h-scrollTop, h-scrolltop, h-scroll-top", never, { "styleClass": { "alias": "styleClass"; "required": false; "isSignal": true; }; "style": { "alias": "style"; "required": false; "isSignal": true; }; "target": { "alias": "target"; "required": false; "isSignal": true; }; "threshold": { "alias": "threshold"; "required": false; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "behavior": { "alias": "behavior"; "required": false; "isSignal": true; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; "isSignal": true; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; "buttonAriaLabel": { "alias": "buttonAriaLabel"; "required": false; "isSignal": true; }; "buttonProps": { "alias": "buttonProps"; "required": false; "isSignal": true; }; }, {}, ["iconTemplate", "templates"], never, true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
+}
+declare class ScrollTopModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ScrollTopModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<ScrollTopModule, never, [typeof ScrollTop, typeof i2.SharedModule], [typeof ScrollTop, typeof i2.SharedModule]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<ScrollTopModule>;
+}
+
+export { ScrollTop, ScrollTopClasses, ScrollTopModule, ScrollTopStyle };