# glennreyes/react-countup architecture

> Architecture diagram of the GitHub repository glennreyes/react-countup, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/glennreyes/react-countup
- Repository: https://github.com/glennreyes/react-countup

## Overview

React CountUp is a small React wrapper around CountUp.js. A consumer uses either the renderable CountUp component or the useCountUp hook, supplies a target and animation options, then starts or lets the counter run and can use controls and callbacks. The component delegates animation lifecycle to the hook; the hook builds and controls the CountUp.js instance. The README documents options including formatting, delays, scroll-spy, plugins, and lifecycle callbacks. The graph reflects the sampled runtime; the README establishes capabilities whose internal implementation was not sampled.

Main entry points: [`src/useCountUp.ts`](https://github.com/glennreyes/react-countup/blob/master/src/useCountUp.ts) (useCountUp hook), [`src/common.ts`](https://github.com/glennreyes/react-countup/blob/master/src/common.ts) (Instance factory), [`src/CountUp.tsx`](https://github.com/glennreyes/react-countup/blob/master/src/CountUp.tsx) (CountUp component), [`src/index.ts`](https://github.com/glennreyes/react-countup/blob/master/src/index.ts) (Package exports)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["React API"]
  node_component["CountUp component<br/>[CountUp.tsx]"]
  node_hook["useCountUp hook<br/>[useCountUp.ts]"]
  node_exports["Package exports<br/>[index.ts]"]
end

subgraph group_runtime["Counter runtime"]
  node_factory["Instance factory<br/>[common.ts]"]
  node_callbacks["Stable callbacks"]
  node_layout["Isomorphic effect"]
  node_contracts["API types<br/>[types.ts]"]
end

node_consumer(("React consumer"))
node_countupjs["CountUp.js"]

node_consumer -->|"renders"| node_component
node_consumer -->|"uses"| node_hook
node_component -->|"delegates to"| node_hook
node_hook -->|"creates instance"| node_factory
node_factory -->|"constructs"| node_countupjs
node_hook -->|"controls"| node_countupjs
node_hook -->|"uses"| node_callbacks
node_callbacks -->|"updates via"| node_layout
node_hook -->|"uses types"| node_contracts
node_factory -->|"uses types"| node_contracts
node_exports -->|"exports"| node_component
node_exports -->|"exports"| node_hook

click node_component "https://github.com/glennreyes/react-countup/blob/master/src/CountUp.tsx"
click node_hook "https://github.com/glennreyes/react-countup/blob/master/src/useCountUp.ts"
click node_factory "https://github.com/glennreyes/react-countup/blob/master/src/common.ts"
click node_callbacks "https://github.com/glennreyes/react-countup/blob/master/src/helpers/useEventCallback.ts"
click node_layout "https://github.com/glennreyes/react-countup/blob/master/src/helpers/useIsomorphicLayoutEffect.ts"
click node_contracts "https://github.com/glennreyes/react-countup/blob/master/src/types.ts"
click node_exports "https://github.com/glennreyes/react-countup/blob/master/src/index.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_component,node_hook,node_exports toneBlue
class node_factory,node_callbacks,node_layout,node_contracts toneAmber
class node_consumer,node_countupjs toneIndigo
```

## Components

### React API

- [CountUp component](https://github.com/glennreyes/react-countup/blob/master/src/CountUp.tsx): `src/CountUp.tsx`
- [useCountUp hook](https://github.com/glennreyes/react-countup/blob/master/src/useCountUp.ts): `src/useCountUp.ts`
- [Package exports](https://github.com/glennreyes/react-countup/blob/master/src/index.ts): `src/index.ts`

### Counter runtime

- [Instance factory](https://github.com/glennreyes/react-countup/blob/master/src/common.ts): `src/common.ts`
- [Stable callbacks](https://github.com/glennreyes/react-countup/blob/master/src/helpers/useEventCallback.ts): `src/helpers/useEventCallback.ts`
- [Isomorphic effect](https://github.com/glennreyes/react-countup/blob/master/src/helpers/useIsomorphicLayoutEffect.ts): `src/helpers/useIsomorphicLayoutEffect.ts`
- [API types](https://github.com/glennreyes/react-countup/blob/master/src/types.ts): `src/types.ts`

### Other components

- **React consumer**
- **CountUp.js**

## Connections

- React consumer → CountUp component: renders (evidence: `README.md`)
- React consumer → useCountUp hook: uses (evidence: `README.md`)
- CountUp component → useCountUp hook: delegates to (evidence: `src/CountUp.tsx`)
- useCountUp hook → Instance factory: creates instance (evidence: `src/useCountUp.ts`)
- Instance factory → CountUp.js: constructs (evidence: `src/common.ts`)
- useCountUp hook → CountUp.js: controls (evidence: `src/useCountUp.ts`)
- useCountUp hook → Stable callbacks: uses (evidence: `src/useCountUp.ts`)
- Stable callbacks → Isomorphic effect: updates via (evidence: `src/helpers/useEventCallback.ts`)
- useCountUp hook → API types: uses types (evidence: `src/useCountUp.ts`)
- Instance factory → API types: uses types (evidence: `src/common.ts`)
- Package exports → CountUp component: exports (evidence: `src/index.ts`)
- Package exports → useCountUp hook: exports (evidence: `src/index.ts`)
