rtl-text-transform 0.0.0-stage → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,261 @@
+type EasingFunction = (t: number) => number;
+/** Linear fallback, useful as an explicit opt-out. */
+declare function linear(t: number): number;
+/**
+ * CSS-style cubic-bezier easing.
+ *
+ * X control points are clamped to 0..1 so the curve remains a function of time.
+ * Y values are left untouched for the caller to clamp if its property needs it.
+ */
+declare function cubicBezier(x1: number, y1: number, x2: number, y2: number): EasingFunction;
+/** Smooth symmetric curve for the overall morph. */
+declare const easeInOutCubic: EasingFunction;
+/** Decelerating curve for entering and exiting hunks. */
+declare const easeOutCubic: EasingFunction;
+
+type MorphDirection = "rtl" | "ltr" | "auto";
+type RiseFlow = "up" | "down" | "left" | "right";
+interface RiseFlowHunk {
+    /** Stable id for the changed chunk. */
+    id: string;
+    /** Added text enters; removed text exits. */
+    kind: "add" | "remove";
+    text: string;
+    /** Source offset in the side's text. */
+    start: number;
+    end: number;
+    /** Length of the side's text. */
+    length: number;
+    /** 0 at the start of the line, 1 at the end. */
+    position: number;
+}
+interface RiseFlowContext {
+    from: string;
+    to: string;
+    dir: MorphDirection;
+    rtl: boolean;
+    hunk: RiseFlowHunk;
+}
+type RiseFlowResolver = (context: RiseFlowContext) => RiseFlow;
+type RiseFlowValue = RiseFlow | RiseFlowResolver;
+type PresetName = "numbers" | "wordsHorizontal" | "wordsUp" | "wordsDown";
+type MotionName = "default" | "smooth" | "snappy" | "gentle";
+type MorphCallback = (from: string, to: string) => void;
+interface GooEffectOptions {
+    /** Blur strength in em, scaled by the host's computed font size. */
+    blur?: number;
+    /** Alpha threshold T in "0 0 0 255 -T". Clamped to 0–255. */
+    threshold?: number;
+    /** Keep the SVG filter mounted while the text is at rest. */
+    atRest?: boolean;
+}
+interface RiseEffectOptions {
+    /** Motion blur strength in em. Applied on top of the goo blur. */
+    blur?: number;
+    /** Vertical travel in em. */
+    travel?: number;
+    /** Scale at the start of an entering hunk. */
+    scale?: number;
+    /** Delay between neighbouring hunks, in milliseconds. */
+    stagger?: number;
+    /** Fraction of the entering window that overlaps the outgoing hunk. */
+    overlap?: number;
+    /** Timing curve for each hunk's enter and exit progress. */
+    easing?: EasingFunction;
+    /**
+     * Direction of travel. `up`: outgoing hunks leave upward and new hunks
+     * arrive from below. `left`: outgoing hunks leave left and new hunks arrive
+     * from the right. A function resolves the direction per changed hunk.
+     */
+    flow?: RiseFlowValue;
+    /** Matched runs shorter than this are treated as changed text. */
+    minChunk?: number;
+    /** Treat Arabic/Persian kaf/yeh as the same letter for diffing. */
+    normalizeVariants?: boolean;
+    /** Do not let combining marks prevent a match. */
+    ignoreDiacritics?: boolean;
+}
+interface MorphEffects {
+    /** Defaults to enabled with the standard goo settings. */
+    goo?: boolean | GooEffectOptions;
+    /** Defaults to disabled. */
+    rise?: boolean | RiseEffectOptions;
+}
+interface MorphOptions {
+    /** Optional auto-cycling list. The first entry is shown immediately. */
+    words?: string[];
+    /** Length of one morph, in seconds. */
+    morphTime?: number;
+    /** Rest between automatic morphs, in seconds. */
+    restTime?: number;
+    effects?: MorphEffects;
+    /** Content preset. See `presets`. */
+    preset?: PresetName;
+    /** Motion preset. Defaults to `default` when a content preset is used. */
+    motion?: MotionName;
+    dir?: MorphDirection;
+    lang?: string;
+    /** Start cycling `words` automatically. Defaults to true. */
+    autoplay?: boolean;
+    /** Wrap around at the end of `words`. Defaults to true. */
+    loop?: boolean;
+    /**
+     * Timing curve for the overall morph and matched-text FLIP. Defaults to
+     * ease-in-out cubic. Pass `t => t` for linear motion.
+     */
+    easing?: EasingFunction;
+    onMorphStart?: MorphCallback;
+    onMorphEnd?: MorphCallback;
+}
+interface Morph {
+    /** Morph from the current visual state to a new string. */
+    setText(text: string): Promise<void>;
+    /** Advance to the next entry in `words`. */
+    next(): Promise<void>;
+    setWords(words: string[]): void;
+    play(): void;
+    pause(): void;
+    destroy(): void;
+    update(partialOptions: Partial<MorphOptions>): void;
+}
+
+/**
+ * Create a unified RTL text morph attached to `el`.
+ *
+ * The host is treated as a dedicated container. Its children are replaced by
+ * two aria-hidden layers and one visually hidden live region; original content
+ * is restored by `destroy()`.
+ */
+declare function createMorph(el: HTMLElement, options?: MorphOptions): Morph;
+
+/**
+ * Normalise Persian, Arabic-Indic and Latin digits, then return the first
+ * numeric value in the string. Used by the numbers preset.
+ */
+declare function firstNumber(value: string): number | undefined;
+/**
+ * Numbers: up when the value increases, down when it decreases. Equal or
+ * unparseable values fall back to up.
+ */
+declare function flowByNumberChange(context: RiseFlowContext): RiseFlow;
+/**
+ * Words: move every changed hunk toward the edge it belongs to. The exact
+ * centre belongs to the end side. RTL flips the physical left/right mapping.
+ */
+declare function flowByHunkPosition(context: RiseFlowContext): RiseFlow;
+declare const presets: {
+    numbers: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                blur: number;
+                travel: number;
+                scale: number;
+                flow: typeof flowByNumberChange;
+            };
+        };
+    };
+    wordsHorizontal: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: typeof flowByHunkPosition;
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+    wordsUp: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: "up";
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+    wordsDown: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: "down";
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+};
+declare const motions: {
+    default: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    smooth: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    snappy: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    gentle: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+};
+declare const presetNames: PresetName[];
+declare const motionNames: MotionName[];
+/**
+ * Resolve a named content preset with optional motion and inline overrides.
+ */
+declare function resolvePreset(name: PresetName, overrides?: MorphOptions): MorphOptions;
+
+export { type EasingFunction, type GooEffectOptions, type Morph, type MorphCallback, type MorphDirection, type MorphEffects, type MorphOptions, type MotionName, type PresetName, type RiseEffectOptions, type RiseFlow, type RiseFlowContext, type RiseFlowHunk, type RiseFlowResolver, type RiseFlowValue, createMorph, cubicBezier, easeInOutCubic, easeOutCubic, firstNumber, flowByHunkPosition, flowByNumberChange, linear, motionNames, motions, presetNames, presets, resolvePreset };

package/dist/index.d.ts

@@ -0,0 +1,261 @@
+type EasingFunction = (t: number) => number;
+/** Linear fallback, useful as an explicit opt-out. */
+declare function linear(t: number): number;
+/**
+ * CSS-style cubic-bezier easing.
+ *
+ * X control points are clamped to 0..1 so the curve remains a function of time.
+ * Y values are left untouched for the caller to clamp if its property needs it.
+ */
+declare function cubicBezier(x1: number, y1: number, x2: number, y2: number): EasingFunction;
+/** Smooth symmetric curve for the overall morph. */
+declare const easeInOutCubic: EasingFunction;
+/** Decelerating curve for entering and exiting hunks. */
+declare const easeOutCubic: EasingFunction;
+
+type MorphDirection = "rtl" | "ltr" | "auto";
+type RiseFlow = "up" | "down" | "left" | "right";
+interface RiseFlowHunk {
+    /** Stable id for the changed chunk. */
+    id: string;
+    /** Added text enters; removed text exits. */
+    kind: "add" | "remove";
+    text: string;
+    /** Source offset in the side's text. */
+    start: number;
+    end: number;
+    /** Length of the side's text. */
+    length: number;
+    /** 0 at the start of the line, 1 at the end. */
+    position: number;
+}
+interface RiseFlowContext {
+    from: string;
+    to: string;
+    dir: MorphDirection;
+    rtl: boolean;
+    hunk: RiseFlowHunk;
+}
+type RiseFlowResolver = (context: RiseFlowContext) => RiseFlow;
+type RiseFlowValue = RiseFlow | RiseFlowResolver;
+type PresetName = "numbers" | "wordsHorizontal" | "wordsUp" | "wordsDown";
+type MotionName = "default" | "smooth" | "snappy" | "gentle";
+type MorphCallback = (from: string, to: string) => void;
+interface GooEffectOptions {
+    /** Blur strength in em, scaled by the host's computed font size. */
+    blur?: number;
+    /** Alpha threshold T in "0 0 0 255 -T". Clamped to 0–255. */
+    threshold?: number;
+    /** Keep the SVG filter mounted while the text is at rest. */
+    atRest?: boolean;
+}
+interface RiseEffectOptions {
+    /** Motion blur strength in em. Applied on top of the goo blur. */
+    blur?: number;
+    /** Vertical travel in em. */
+    travel?: number;
+    /** Scale at the start of an entering hunk. */
+    scale?: number;
+    /** Delay between neighbouring hunks, in milliseconds. */
+    stagger?: number;
+    /** Fraction of the entering window that overlaps the outgoing hunk. */
+    overlap?: number;
+    /** Timing curve for each hunk's enter and exit progress. */
+    easing?: EasingFunction;
+    /**
+     * Direction of travel. `up`: outgoing hunks leave upward and new hunks
+     * arrive from below. `left`: outgoing hunks leave left and new hunks arrive
+     * from the right. A function resolves the direction per changed hunk.
+     */
+    flow?: RiseFlowValue;
+    /** Matched runs shorter than this are treated as changed text. */
+    minChunk?: number;
+    /** Treat Arabic/Persian kaf/yeh as the same letter for diffing. */
+    normalizeVariants?: boolean;
+    /** Do not let combining marks prevent a match. */
+    ignoreDiacritics?: boolean;
+}
+interface MorphEffects {
+    /** Defaults to enabled with the standard goo settings. */
+    goo?: boolean | GooEffectOptions;
+    /** Defaults to disabled. */
+    rise?: boolean | RiseEffectOptions;
+}
+interface MorphOptions {
+    /** Optional auto-cycling list. The first entry is shown immediately. */
+    words?: string[];
+    /** Length of one morph, in seconds. */
+    morphTime?: number;
+    /** Rest between automatic morphs, in seconds. */
+    restTime?: number;
+    effects?: MorphEffects;
+    /** Content preset. See `presets`. */
+    preset?: PresetName;
+    /** Motion preset. Defaults to `default` when a content preset is used. */
+    motion?: MotionName;
+    dir?: MorphDirection;
+    lang?: string;
+    /** Start cycling `words` automatically. Defaults to true. */
+    autoplay?: boolean;
+    /** Wrap around at the end of `words`. Defaults to true. */
+    loop?: boolean;
+    /**
+     * Timing curve for the overall morph and matched-text FLIP. Defaults to
+     * ease-in-out cubic. Pass `t => t` for linear motion.
+     */
+    easing?: EasingFunction;
+    onMorphStart?: MorphCallback;
+    onMorphEnd?: MorphCallback;
+}
+interface Morph {
+    /** Morph from the current visual state to a new string. */
+    setText(text: string): Promise<void>;
+    /** Advance to the next entry in `words`. */
+    next(): Promise<void>;
+    setWords(words: string[]): void;
+    play(): void;
+    pause(): void;
+    destroy(): void;
+    update(partialOptions: Partial<MorphOptions>): void;
+}
+
+/**
+ * Create a unified RTL text morph attached to `el`.
+ *
+ * The host is treated as a dedicated container. Its children are replaced by
+ * two aria-hidden layers and one visually hidden live region; original content
+ * is restored by `destroy()`.
+ */
+declare function createMorph(el: HTMLElement, options?: MorphOptions): Morph;
+
+/**
+ * Normalise Persian, Arabic-Indic and Latin digits, then return the first
+ * numeric value in the string. Used by the numbers preset.
+ */
+declare function firstNumber(value: string): number | undefined;
+/**
+ * Numbers: up when the value increases, down when it decreases. Equal or
+ * unparseable values fall back to up.
+ */
+declare function flowByNumberChange(context: RiseFlowContext): RiseFlow;
+/**
+ * Words: move every changed hunk toward the edge it belongs to. The exact
+ * centre belongs to the end side. RTL flips the physical left/right mapping.
+ */
+declare function flowByHunkPosition(context: RiseFlowContext): RiseFlow;
+declare const presets: {
+    numbers: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                blur: number;
+                travel: number;
+                scale: number;
+                flow: typeof flowByNumberChange;
+            };
+        };
+    };
+    wordsHorizontal: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: typeof flowByHunkPosition;
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+    wordsUp: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: "up";
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+    wordsDown: {
+        effects: {
+            goo: {
+                blur: number;
+                threshold: number;
+                atRest: boolean;
+            };
+            rise: {
+                flow: "down";
+                blur: number;
+                travel: number;
+                scale: number;
+            };
+        };
+    };
+};
+declare const motions: {
+    default: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    smooth: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    snappy: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+    gentle: {
+        morphTime: number;
+        easing: EasingFunction;
+        effects: {
+            rise: {
+                easing: EasingFunction;
+                stagger: number;
+                overlap: number;
+            };
+        };
+    };
+};
+declare const presetNames: PresetName[];
+declare const motionNames: MotionName[];
+/**
+ * Resolve a named content preset with optional motion and inline overrides.
+ */
+declare function resolvePreset(name: PresetName, overrides?: MorphOptions): MorphOptions;
+
+export { type EasingFunction, type GooEffectOptions, type Morph, type MorphCallback, type MorphDirection, type MorphEffects, type MorphOptions, type MotionName, type PresetName, type RiseEffectOptions, type RiseFlow, type RiseFlowContext, type RiseFlowHunk, type RiseFlowResolver, type RiseFlowValue, createMorph, cubicBezier, easeInOutCubic, easeOutCubic, firstNumber, flowByHunkPosition, flowByNumberChange, linear, motionNames, motions, presetNames, presets, resolvePreset };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { createMorph, cubicBezier, easeInOutCubic, easeOutCubic, firstNumber, flowByHunkPosition, flowByNumberChange, linear, motionNames, motions, presetNames, presets, resolvePreset } from './chunk-QDWUKRPS.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}