@radix-ng/primitives 1.0.0-beta.0 → 1.0.0-beta.2

package/types/radix-ng-primitives-scroll-area.d.ts

@@ -0,0 +1,253 @@
+import * as _angular_core from '@angular/core';
+import { Signal } from '@angular/core';
+import * as _radix_ng_primitives_core from '@radix-ng/primitives/core';
+import { Direction, BooleanInput } from '@radix-ng/primitives/core';
+import * as _radix_ng_primitives_scroll_area from '@radix-ng/primitives/scroll-area';
+
+type Size = {
+    width: number;
+    height: number;
+};
+type Coords = {
+    x: number;
+    y: number;
+};
+type OverflowEdges = {
+    xStart: boolean;
+    xEnd: boolean;
+    yStart: boolean;
+    yEnd: boolean;
+};
+type HiddenState = {
+    x: boolean;
+    y: boolean;
+    corner: boolean;
+};
+/** A minimal, React-`ref`-like mutable holder shared through context. */
+type MutableRef<T> = {
+    current: T | null;
+};
+type OverflowEdgeThreshold = number | Partial<{
+    xStart: number;
+    xEnd: number;
+    yStart: number;
+    yEnd: number;
+}>;
+interface ScrollAreaRootContext {
+    readonly rootId: string;
+    readonly direction: Signal<Direction>;
+    readonly overflowEdgeThreshold: Signal<{
+        xStart: number;
+        xEnd: number;
+        yStart: number;
+        yEnd: number;
+    }>;
+    readonly hovering: Signal<boolean>;
+    readonly scrollingX: Signal<boolean>;
+    readonly scrollingY: Signal<boolean>;
+    readonly touchModality: Signal<boolean>;
+    readonly hasMeasuredScrollbar: Signal<boolean>;
+    readonly cornerSize: Signal<Size>;
+    readonly thumbSize: Signal<Size>;
+    readonly hiddenState: Signal<HiddenState>;
+    readonly overflowEdges: Signal<OverflowEdges>;
+    readonly rootRef: MutableRef<HTMLElement>;
+    readonly viewportRef: MutableRef<HTMLElement>;
+    readonly scrollbarYRef: MutableRef<HTMLElement>;
+    readonly scrollbarXRef: MutableRef<HTMLElement>;
+    readonly thumbYRef: MutableRef<HTMLElement>;
+    readonly thumbXRef: MutableRef<HTMLElement>;
+    readonly cornerRef: MutableRef<HTMLElement>;
+    setHovering(value: boolean): void;
+    setHasMeasuredScrollbar(value: boolean): void;
+    setScrollingX(value: boolean): void;
+    setScrollingY(value: boolean): void;
+    setThumbSize(value: Size): void;
+    setCornerSize(value: Size): void;
+    setHiddenState(value: HiddenState): void;
+    setOverflowEdges(value: OverflowEdges): void;
+    handleScroll(position: Coords): void;
+    handlePointerDown(event: PointerEvent): void;
+    handlePointerMove(event: PointerEvent): void;
+    handlePointerUp(event: PointerEvent): void;
+}
+declare const injectScrollAreaRootContext: _radix_ng_primitives_core.InjectContext<ScrollAreaRootContext>;
+declare const provideScrollAreaRootContext: (useFactory: () => ScrollAreaRootContext) => _angular_core.Provider;
+/**
+ * Groups all parts of the scroll area.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaRoot {
+    private readonly destroyRef;
+    readonly rootId: string;
+    /** Text direction of the scroll area. Affects horizontal (RTL) scroll math. */
+    readonly dir: _angular_core.InputSignal<Direction>;
+    readonly direction: Signal<Direction>;
+    /**
+     * The threshold in pixels that must be passed before the overflow edge attributes are applied.
+     * Accepts a single number for all edges or an object to configure them individually.
+     */
+    readonly overflowEdgeThreshold: _angular_core.InputSignal<OverflowEdgeThreshold>;
+    readonly normalizedThreshold: Signal<{
+        xStart: number;
+        xEnd: number;
+        yStart: number;
+        yEnd: number;
+    }>;
+    readonly hovering: _angular_core.WritableSignal<boolean>;
+    readonly scrollingX: _angular_core.WritableSignal<boolean>;
+    readonly scrollingY: _angular_core.WritableSignal<boolean>;
+    readonly touchModality: _angular_core.WritableSignal<boolean>;
+    readonly hasMeasuredScrollbar: _angular_core.WritableSignal<boolean>;
+    readonly cornerSize: _angular_core.WritableSignal<Size>;
+    readonly thumbSize: _angular_core.WritableSignal<Size>;
+    readonly hiddenState: _angular_core.WritableSignal<HiddenState>;
+    readonly overflowEdges: _angular_core.WritableSignal<OverflowEdges>;
+    readonly rootRef: MutableRef<HTMLElement>;
+    readonly viewportRef: MutableRef<HTMLElement>;
+    readonly scrollbarYRef: MutableRef<HTMLElement>;
+    readonly scrollbarXRef: MutableRef<HTMLElement>;
+    readonly thumbYRef: MutableRef<HTMLElement>;
+    readonly thumbXRef: MutableRef<HTMLElement>;
+    readonly cornerRef: MutableRef<HTMLElement>;
+    private thumbDragging;
+    private startY;
+    private startX;
+    private startScrollTop;
+    private startScrollLeft;
+    private currentOrientation;
+    private scrollPosition;
+    private scrollYTimer;
+    private scrollXTimer;
+    constructor();
+    setScrollingX(value: boolean): void;
+    setScrollingY(value: boolean): void;
+    setThumbSize(value: Size): void;
+    setCornerSize(value: Size): void;
+    setHiddenState(value: HiddenState): void;
+    setOverflowEdges(value: OverflowEdges): void;
+    handleScroll(scrollPosition: Coords): void;
+    handlePointerDown(event: PointerEvent): void;
+    handlePointerMove(event: PointerEvent): void;
+    handlePointerUp(event: PointerEvent): void;
+    onTouchModalityChange(event: PointerEvent): void;
+    onPointerEnterOrMove(event: PointerEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaRoot, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaRoot, "[rdxScrollAreaRoot]", ["rdxScrollAreaRoot"], { "dir": { "alias": "dir"; "required": false; "isSignal": true; }; "overflowEdgeThreshold": { "alias": "overflowEdgeThreshold"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+interface ScrollAreaViewportContext {
+    /** Re-measures the viewport and repositions the thumbs. Called by the content's ResizeObserver. */
+    computeThumbPosition(): void;
+}
+declare const injectScrollAreaViewportContext: _radix_ng_primitives_core.InjectContext<ScrollAreaViewportContext>;
+declare const provideScrollAreaViewportContext: (useFactory: () => ScrollAreaViewportContext) => _angular_core.Provider;
+/**
+ * The actual scrollable container of the scroll area.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaViewport {
+    protected readonly rootContext: _radix_ng_primitives_scroll_area.ScrollAreaRootContext;
+    private readonly element;
+    private readonly destroyRef;
+    private readonly isBrowser;
+    private programmaticScroll;
+    private lastMeasuredMetrics;
+    private scrollEndTimer;
+    private animationsTimer;
+    constructor();
+    computeThumbPosition(): void;
+    onScroll(): void;
+    onUserInteraction(): void;
+    private observeViewport;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaViewport, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaViewport, "[rdxScrollAreaViewport]", ["rdxScrollAreaViewport"], {}, {}, never, never, true, never>;
+}
+
+/**
+ * A container for the content of the scroll area.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaContent {
+    protected readonly rootContext: _radix_ng_primitives_scroll_area.ScrollAreaRootContext;
+    private readonly viewportContext;
+    private readonly element;
+    private readonly destroyRef;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaContent, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaContent, "[rdxScrollAreaContent]", ["rdxScrollAreaContent"], {}, {}, never, never, true, never>;
+}
+
+type ScrollbarOrientation = 'vertical' | 'horizontal';
+interface ScrollAreaScrollbarContext {
+    orientation: () => ScrollbarOrientation;
+}
+declare const injectScrollAreaScrollbarContext: _radix_ng_primitives_core.InjectContext<ScrollAreaScrollbarContext>;
+declare const provideScrollAreaScrollbarContext: (useFactory: () => ScrollAreaScrollbarContext) => _angular_core.Provider;
+/**
+ * A vertical or horizontal scrollbar for the scroll area.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaScrollbar {
+    protected readonly rootContext: _radix_ng_primitives_scroll_area.ScrollAreaRootContext;
+    private readonly element;
+    /** Whether the scrollbar controls vertical or horizontal scroll. */
+    readonly orientation: _angular_core.InputSignal<ScrollbarOrientation>;
+    /** Whether to keep the element rendered when the viewport isn't scrollable. */
+    readonly keepMounted: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
+    protected readonly scrolling: _angular_core.Signal<boolean>;
+    private readonly isHidden;
+    protected readonly shouldRender: _angular_core.Signal<boolean>;
+    protected readonly hideTrackUntilMeasured: _angular_core.Signal<boolean>;
+    constructor();
+    onWheel(event: WheelEvent): void;
+    onPointerDown(event: PointerEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaScrollbar, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaScrollbar, "[rdxScrollAreaScrollbar]", ["rdxScrollAreaScrollbar"], { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "keepMounted": { "alias": "keepMounted"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * The draggable part of the scrollbar that indicates the current scroll position.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaThumb {
+    protected readonly rootContext: _radix_ng_primitives_scroll_area.ScrollAreaRootContext;
+    protected readonly scrollbarContext: _radix_ng_primitives_scroll_area.ScrollAreaScrollbarContext;
+    private readonly element;
+    constructor();
+    endDrag(event: PointerEvent): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaThumb, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaThumb, "[rdxScrollAreaThumb]", ["rdxScrollAreaThumb"], {}, {}, never, never, true, never>;
+}
+
+/**
+ * A small rectangular area that appears at the intersection of horizontal and vertical scrollbars.
+ * Renders a `<div>` element.
+ *
+ * @group Components
+ */
+declare class RdxScrollAreaCorner {
+    protected readonly rootContext: _radix_ng_primitives_scroll_area.ScrollAreaRootContext;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaCorner, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<RdxScrollAreaCorner, "[rdxScrollAreaCorner]", ["rdxScrollAreaCorner"], {}, {}, never, never, true, never>;
+}
+
+declare class RdxScrollAreaModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<RdxScrollAreaModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<RdxScrollAreaModule, never, [typeof RdxScrollAreaRoot, typeof RdxScrollAreaViewport, typeof RdxScrollAreaContent, typeof RdxScrollAreaScrollbar, typeof RdxScrollAreaThumb, typeof RdxScrollAreaCorner], [typeof RdxScrollAreaRoot, typeof RdxScrollAreaViewport, typeof RdxScrollAreaContent, typeof RdxScrollAreaScrollbar, typeof RdxScrollAreaThumb, typeof RdxScrollAreaCorner]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<RdxScrollAreaModule>;
+}
+
+export { RdxScrollAreaContent, RdxScrollAreaCorner, RdxScrollAreaModule, RdxScrollAreaRoot, RdxScrollAreaScrollbar, RdxScrollAreaThumb, RdxScrollAreaViewport, injectScrollAreaRootContext, injectScrollAreaScrollbarContext, injectScrollAreaViewportContext, provideScrollAreaRootContext, provideScrollAreaScrollbarContext, provideScrollAreaViewportContext };
+export type { Coords, HiddenState, MutableRef, OverflowEdgeThreshold, OverflowEdges, ScrollAreaRootContext, ScrollAreaScrollbarContext, ScrollAreaViewportContext, ScrollbarOrientation, Size };