@dcg-overseas/number-line 0.1.6 → 0.1.7

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+import { default as default_2 } from 'react';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+
+export declare function NumberLine({ className }: {
+    className?: string;
+}): JSX_2.Element;
+
+export declare interface NumberLineContextValue {
+    svgRef: default_2.RefObject<SVGSVGElement>;
+    containerWidth: number;
+    containerHeight: number;
+    svgCursor: string;
+    min: number;
+    max: number;
+    groupSize: number;
+    groupCount: number;
+    tickStep: number;
+    arcColors?: string[];
+    showGroupTicks: boolean;
+    showMajorTicks: boolean;
+    showMinorTicks: boolean;
+    viewMin: number;
+    viewMax: number;
+    enableZoom: boolean;
+    resetView: () => void;
+    zoomAt: (factor: number, fraction: number) => void;
+    panByFraction: (df: number) => void;
+    tool: Tool;
+    strokes: Stroke[];
+    liveStroke: Stroke | null;
+    selectedArcIndices: Set<number>;
+    deletedArcIndices: Set<number>;
+    onPointerDown: (e: default_2.PointerEvent<SVGSVGElement>) => void;
+    onPointerMove: (e: default_2.PointerEvent<SVGSVGElement>) => void;
+    onPointerUp: () => void;
+    onStrokeClick: (id: string, e: default_2.PointerEvent) => void;
+    onArcClick: (groupIndex: number, e: default_2.PointerEvent) => void;
+    canDelete: boolean;
+    canUndo: boolean;
+    onTogglePen: () => void;
+    onToggleEraser: () => void;
+    onDelete: () => void;
+    onReset: () => void;
+    onUndo: () => void;
+}
+
+export declare interface NumberLineProps {
+    min: number;
+    max: number;
+    groupSize: number;
+    groupCount: number;
+    tickStep: number;
+    arcColors?: string[];
+    /** show group boundary ticks (tallest). Default: true */
+    showGroupTicks?: boolean;
+    /** show major ticks. Default: true */
+    showMajorTicks?: boolean;
+    /** show minor ticks (in-between). Default: false */
+    showMinorTicks?: boolean;
+    /** enable mouse-wheel / pinch zoom + drag-to-pan. Default: false */
+    enableZoom?: boolean;
+    /** minimum zoom level. 1 = full [min, max] range. Default: 1 */
+    minZoom?: number;
+    /** maximum zoom level. Default: 50 */
+    maxZoom?: number;
+    /** controlled view: if both provided, viewport is driven by parent */
+    viewMin?: number;
+    viewMax?: number;
+    /** fired whenever internal viewport changes (uncontrolled mode) */
+    onViewChange?: (viewMin: number, viewMax: number) => void;
+}
+
+export declare function NumberLineProvider({ min, max, groupSize, groupCount, tickStep, arcColors, showGroupTicks, showMajorTicks, showMinorTicks, enableZoom, minZoom, maxZoom, viewMin: controlledViewMin, viewMax: controlledViewMax, onViewChange, children, }: NumberLineProviderProps): JSX_2.Element;
+
+declare interface NumberLineProviderProps extends NumberLineProps {
+    children: default_2.ReactNode;
+}
+
+declare interface Stroke {
+    id: string;
+    d: string;
+    selected: boolean;
+}
+
+declare type Tool = 'none' | 'pen' | 'eraser';
+
+export declare function useNumberLineContext(): NumberLineContextValue;
+
+export { }