@number-flow/react 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# Number Flow
+
+Smooth transitions for `Intl.NumberFormat`.
+
+[![MotionNumber for Framer Motion](https://motion-number.barvian.me/preview.webp)](https://motion-number.barvian.me)
+
+[![NPM Version](https://img.shields.io/npm/v/motion-number.svg)](https://npmjs.com/package/motion-number)
+[![Bundle size](https://badgen.net/bundlephobia/minzip/motion-number@latest)](https://bundlephobia.com/package/motion-number@latest)
+[![Follow @mbarvian](https://img.shields.io/twitter/follow/mbarvian.svg?style=social&label=Follow)](https://x.com/mbarvian)
+
+---
+
+## Documentation
+
+For full documentation, visit [number-flow.barvian.me](https://number-flow.barvian.me).

package/dist/framer-motion.d.mts

@@ -0,0 +1,5 @@
+import { Transition } from 'framer-motion';
+
+declare const defaultXTiming: Transition;
+
+export { defaultXTiming };

package/dist/framer-motion.d.ts

@@ -0,0 +1,5 @@
+import { Transition } from 'framer-motion';
+
+declare const defaultXTiming: Transition;
+
+export { defaultXTiming };

package/dist/framer-motion.js

@@ -0,0 +1,42 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/framer-motion.ts
+var framer_motion_exports = {};
+__export(framer_motion_exports, {
+  defaultXTiming: () => defaultXTiming
+});
+module.exports = __toCommonJS(framer_motion_exports);
+var import_number_flow = require("number-flow");
+var import_framer_motion = require("framer-motion");
+var defaultTransformer = (0, import_framer_motion.transform)(
+  import_number_flow.defaultXTimingLinearPoints.map((_, i) => i / (import_number_flow.defaultXTimingLinearPoints.length - 1)),
+  import_number_flow.defaultXTimingLinearPoints
+);
+var defaultXTiming = import_number_flow.supportsLinear ? {
+  duration: import_number_flow.defaultXTimingLinearDuration / 1e3,
+  ease: defaultTransformer
+} : {
+  duration: import_number_flow.defaultXTimingFallbackDuration / 1e3,
+  easing: import_number_flow.defaultXTimingFallbackPoints
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defaultXTiming
+});

package/dist/framer-motion.mjs

@@ -0,0 +1,23 @@
+// src/framer-motion.ts
+import {
+  supportsLinear,
+  defaultXTimingFallbackPoints,
+  defaultXTimingFallbackDuration,
+  defaultXTimingLinearDuration,
+  defaultXTimingLinearPoints
+} from "number-flow";
+import { transform } from "framer-motion";
+var defaultTransformer = transform(
+  defaultXTimingLinearPoints.map((_, i) => i / (defaultXTimingLinearPoints.length - 1)),
+  defaultXTimingLinearPoints
+);
+var defaultXTiming = supportsLinear ? {
+  duration: defaultXTimingLinearDuration / 1e3,
+  ease: defaultTransformer
+} : {
+  duration: defaultXTimingFallbackDuration / 1e3,
+  easing: defaultXTimingFallbackPoints
+};
+export {
+  defaultXTiming
+};

package/dist/index.d.mts

@@ -0,0 +1,31 @@
+import * as React from 'react';
+import { NumberFlowLite, Value, Format } from 'number-flow';
+export * from 'number-flow';
+export { defaultXTiming, defaultYTiming } from 'number-flow';
+
+declare const OBSERVED_ATTRIBUTES: readonly ["parts"];
+type ObservedAttribute = (typeof OBSERVED_ATTRIBUTES)[number];
+declare class NumberFlowElement extends NumberFlowLite {
+    static observedAttributes: readonly ["parts"];
+    attributeChangedCallback(attr: ObservedAttribute, _oldValue: string, newValue: string): void;
+}
+type NumberFlowProps = React.HTMLAttributes<NumberFlowElement> & {
+    value: Value;
+    locales?: Intl.LocalesArgument;
+    format?: Format;
+    root?: (typeof NumberFlowElement)['prototype']['root'];
+    fadeTiming?: (typeof NumberFlowElement)['prototype']['fadeTiming'];
+    xTiming?: (typeof NumberFlowElement)['prototype']['xTiming'];
+    yTiming?: (typeof NumberFlowElement)['prototype']['yTiming'];
+};
+declare const NumberFlow: React.ForwardRefExoticComponent<React.HTMLAttributes<NumberFlowElement> & {
+    value: Value;
+    locales?: Intl.LocalesArgument;
+    format?: Format;
+    root?: (typeof NumberFlowElement)["prototype"]["root"];
+    fadeTiming?: (typeof NumberFlowElement)["prototype"]["fadeTiming"];
+    xTiming?: (typeof NumberFlowElement)["prototype"]["xTiming"];
+    yTiming?: (typeof NumberFlowElement)["prototype"]["yTiming"];
+} & React.RefAttributes<NumberFlowElement>>;
+
+export { NumberFlowElement, type NumberFlowProps, NumberFlow as default };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import * as React from 'react';
+import { NumberFlowLite, Value, Format } from 'number-flow';
+export * from 'number-flow';
+export { defaultXTiming, defaultYTiming } from 'number-flow';
+
+declare const OBSERVED_ATTRIBUTES: readonly ["parts"];
+type ObservedAttribute = (typeof OBSERVED_ATTRIBUTES)[number];
+declare class NumberFlowElement extends NumberFlowLite {
+    static observedAttributes: readonly ["parts"];
+    attributeChangedCallback(attr: ObservedAttribute, _oldValue: string, newValue: string): void;
+}
+type NumberFlowProps = React.HTMLAttributes<NumberFlowElement> & {
+    value: Value;
+    locales?: Intl.LocalesArgument;
+    format?: Format;
+    root?: (typeof NumberFlowElement)['prototype']['root'];
+    fadeTiming?: (typeof NumberFlowElement)['prototype']['fadeTiming'];
+    xTiming?: (typeof NumberFlowElement)['prototype']['xTiming'];
+    yTiming?: (typeof NumberFlowElement)['prototype']['yTiming'];
+};
+declare const NumberFlow: React.ForwardRefExoticComponent<React.HTMLAttributes<NumberFlowElement> & {
+    value: Value;
+    locales?: Intl.LocalesArgument;
+    format?: Format;
+    root?: (typeof NumberFlowElement)["prototype"]["root"];
+    fadeTiming?: (typeof NumberFlowElement)["prototype"]["fadeTiming"];
+    xTiming?: (typeof NumberFlowElement)["prototype"]["xTiming"];
+    yTiming?: (typeof NumberFlowElement)["prototype"]["yTiming"];
+} & React.RefAttributes<NumberFlowElement>>;
+
+export { NumberFlowElement, type NumberFlowProps, NumberFlow as default };

package/dist/index.js

@@ -0,0 +1,130 @@
+"use strict";
+"use client";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.tsx
+var src_exports = {};
+__export(src_exports, {
+  NumberFlowElement: () => NumberFlowElement,
+  default: () => src_default,
+  defaultXTiming: () => import_number_flow2.defaultXTiming,
+  defaultYTiming: () => import_number_flow2.defaultYTiming
+});
+module.exports = __toCommonJS(src_exports);
+var React = __toESM(require("react"));
+var import_number_flow = require("number-flow");
+var import_number_flow2 = require("number-flow");
+var OBSERVED_ATTRIBUTES = ["parts"];
+var NumberFlowElement = class extends import_number_flow.NumberFlowLite {
+  static observedAttributes = OBSERVED_ATTRIBUTES;
+  attributeChangedCallback(attr, _oldValue, newValue) {
+    this[attr] = JSON.parse(newValue);
+  }
+};
+NumberFlowElement.define();
+var formatters = {};
+var NumberFlowPriv = class extends React.Component {
+  constructor(props) {
+    super(props);
+    this.handleRef = this.handleRef.bind(this);
+  }
+  // Update the non-parts props to avoid JSON serialization
+  // Parts needs to be set in render still:
+  updateNonPartsProps() {
+    if (this.#el) {
+      if (this.props.root != null) this.#el.root = this.props.root;
+      if (this.props.fadeTiming) this.#el.fadeTiming = this.props.fadeTiming;
+      if (this.props.xTiming) this.#el.xTiming = this.props.xTiming;
+      if (this.props.yTiming) this.#el.yTiming = this.props.yTiming;
+    }
+  }
+  componentDidMount() {
+    this.updateNonPartsProps();
+    if (this.#el) this.#el.manual = true;
+  }
+  getSnapshotBeforeUpdate() {
+    this.updateNonPartsProps();
+    this.#el?.willUpdate();
+    return null;
+  }
+  componentDidUpdate() {
+    this.#el?.didUpdate();
+  }
+  #el;
+  handleRef(el) {
+    if (this.props.innerRef) this.props.innerRef.current = el;
+    this.#el = el;
+  }
+  render() {
+    const {
+      innerRef,
+      className,
+      parts,
+      // These are set in updateNonPartsProps, so ignore them here:
+      fadeTiming,
+      xTiming,
+      yTiming,
+      ...rest
+    } = this.props;
+    return (
+      // @ts-expect-error missing types
+      /* @__PURE__ */ React.createElement(
+        "number-flow",
+        {
+          ref: this.handleRef,
+          class: className,
+          ...rest,
+          parts: JSON.stringify(parts)
+        },
+        /* @__PURE__ */ React.createElement(import_number_flow.SlottedTag, { style: import_number_flow.slottedStyles }, parts.formatted)
+      )
+    );
+  }
+};
+var NumberFlow = React.forwardRef(function NumberFlow2({ value, locales, format, ...props }, _ref) {
+  React.useImperativeHandle(_ref, () => ref.current, []);
+  const ref = React.useRef();
+  const localesString = React.useMemo(() => locales ? JSON.stringify(locales) : "", [locales]);
+  const formatString = React.useMemo(() => format ? JSON.stringify(format) : "", [format]);
+  const parts = React.useMemo(() => {
+    const formatter = formatters[`${localesString}:${formatString}`] ??= new Intl.NumberFormat(
+      locales,
+      format
+    );
+    return (0, import_number_flow.partitionParts)(value, formatter);
+  }, [value, localesString, formatString]);
+  return /* @__PURE__ */ React.createElement(NumberFlowPriv, { ...props, parts, innerRef: ref });
+});
+var src_default = NumberFlow;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  NumberFlowElement,
+  defaultXTiming,
+  defaultYTiming
+});

package/dist/index.mjs

@@ -0,0 +1,99 @@
+"use client";
+
+// src/index.tsx
+import * as React from "react";
+import {
+  SlottedTag,
+  slottedStyles,
+  partitionParts,
+  NumberFlowLite
+} from "number-flow";
+import { defaultXTiming, defaultYTiming } from "number-flow";
+var OBSERVED_ATTRIBUTES = ["parts"];
+var NumberFlowElement = class extends NumberFlowLite {
+  static observedAttributes = OBSERVED_ATTRIBUTES;
+  attributeChangedCallback(attr, _oldValue, newValue) {
+    this[attr] = JSON.parse(newValue);
+  }
+};
+NumberFlowElement.define();
+var formatters = {};
+var NumberFlowPriv = class extends React.Component {
+  constructor(props) {
+    super(props);
+    this.handleRef = this.handleRef.bind(this);
+  }
+  // Update the non-parts props to avoid JSON serialization
+  // Parts needs to be set in render still:
+  updateNonPartsProps() {
+    if (this.#el) {
+      if (this.props.root != null) this.#el.root = this.props.root;
+      if (this.props.fadeTiming) this.#el.fadeTiming = this.props.fadeTiming;
+      if (this.props.xTiming) this.#el.xTiming = this.props.xTiming;
+      if (this.props.yTiming) this.#el.yTiming = this.props.yTiming;
+    }
+  }
+  componentDidMount() {
+    this.updateNonPartsProps();
+    if (this.#el) this.#el.manual = true;
+  }
+  getSnapshotBeforeUpdate() {
+    this.updateNonPartsProps();
+    this.#el?.willUpdate();
+    return null;
+  }
+  componentDidUpdate() {
+    this.#el?.didUpdate();
+  }
+  #el;
+  handleRef(el) {
+    if (this.props.innerRef) this.props.innerRef.current = el;
+    this.#el = el;
+  }
+  render() {
+    const {
+      innerRef,
+      className,
+      parts,
+      // These are set in updateNonPartsProps, so ignore them here:
+      fadeTiming,
+      xTiming,
+      yTiming,
+      ...rest
+    } = this.props;
+    return (
+      // @ts-expect-error missing types
+      /* @__PURE__ */ React.createElement(
+        "number-flow",
+        {
+          ref: this.handleRef,
+          class: className,
+          ...rest,
+          parts: JSON.stringify(parts)
+        },
+        /* @__PURE__ */ React.createElement(SlottedTag, { style: slottedStyles }, parts.formatted)
+      )
+    );
+  }
+};
+var NumberFlow = React.forwardRef(function NumberFlow2({ value, locales, format, ...props }, _ref) {
+  React.useImperativeHandle(_ref, () => ref.current, []);
+  const ref = React.useRef();
+  const localesString = React.useMemo(() => locales ? JSON.stringify(locales) : "", [locales]);
+  const formatString = React.useMemo(() => format ? JSON.stringify(format) : "", [format]);
+  const parts = React.useMemo(() => {
+    const formatter = formatters[`${localesString}:${formatString}`] ??= new Intl.NumberFormat(
+      locales,
+      format
+    );
+    return partitionParts(value, formatter);
+  }, [value, localesString, formatString]);
+  return /* @__PURE__ */ React.createElement(NumberFlowPriv, { ...props, parts, innerRef: ref });
+});
+var src_default = NumberFlow;
+export {
+  NumberFlowElement,
+  src_default as default,
+  defaultXTiming,
+  defaultYTiming
+};

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@number-flow/react",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.0",
+  "author": {
+    "name": "Maxwell Barvian",
+    "email": "max@barvian.me",
+    "url": "https://barvian.me"
+  },
+  "description": "A lightweight component to transition and format numbers.",
+  "license": "MIT",
+  "homepage": "https://number-flow.barvian.me/react",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/barvian/number-flow",
+    "directory": "src"
+  },
+  "bugs": {
+    "url": "https://github.com/barvian/number-flow/issues"
+  },
+  "keywords": [
+    "accessible",
+    "odometer",
+    "animation",
+    "number-format",
+    "number-animation",
+    "animated-number"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./framer-motion": {
+      "import": {
+        "types": "./dist/framer-motion.d.mts",
+        "default": "./dist/framer-motion.mjs"
+      },
+      "require": {
+        "types": "./dist/framer-motion.d.ts",
+        "default": "./dist/framer-motion.js"
+      }
+    }
+  },
+  "dependencies": {
+    "esm-env": "^1.0.0",
+    "number-flow": "0.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "framer-motion": "^11.9.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.2.4"
+  },
+  "peerDependencies": {
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "framer-motion": "^11.0.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "peerDependenciesMeta": {
+    "framer-motion": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsup --tsconfig tsconfig.build.json",
+    "dev": "tsup --watch"
+  }
+}