Documentation
/
Type at least two characters to search.
Data display
AnimatedNumber
Animates a formatted metric while keeping one stable accessible value.
01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
Active workspaces
1,234Deploy success
99.8%Median build
42sFramework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
import { AnimatedNumber, Stat } from '@santi020k/lumen-astro'
---
<div style="display: grid; gap: 1rem; grid-template-columns: repeat(3, minmax(0, 1fr));">
<Stat label="Active workspaces">
<span class="ui-stat-value"><AnimatedNumber value={1234} /></span>
</Stat>
<Stat label="Deploy success">
<span class="ui-stat-value"><AnimatedNumber decimals={1} suffix="%" value={99.8} /></span>
</Stat>
<Stat label="Median build">
<span class="ui-stat-value"><AnimatedNumber suffix="s" value={42} /></span>
</Stat>
</div>---
import { AnimatedNumber, Stat } from '@santi020k/lumen-astro'
---
<div style="display: grid; gap: 1rem; grid-template-columns: repeat(3, minmax(0, 1fr));">
<Stat label="Active workspaces">
<span class="ui-stat-value"><AnimatedNumber value={1234} /></span>
</Stat>
<Stat label="Deploy success">
<span class="ui-stat-value"><AnimatedNumber decimals={1} suffix="%" value={99.8} /></span>
</Stat>
<Stat label="Median build">
<span class="ui-stat-value"><AnimatedNumber suffix="s" value={42} /></span>
</Stat>
</div>import { AnimatedNumber, Stat } from '@santi020k/lumen-react'
export const Example = () => (
<>
<div style={{ display: 'grid', gap: '1rem', gridTemplateColumns: 'repeat(3, minmax(0, 1fr))' }}>
<Stat label="Active workspaces">
<span className="ui-stat-value"><AnimatedNumber value={1234} /></span>
</Stat>
<Stat label="Deploy success">
<span className="ui-stat-value"><AnimatedNumber decimals={1} suffix="%" value={99.8} /></span>
</Stat>
<Stat label="Median build">
<span className="ui-stat-value"><AnimatedNumber suffix="s" value={42} /></span>
</Stat>
</div>
</>
)import { AnimatedNumber, Stat } from '@santi020k/lumen-react'
export const Example = () => (
<>
<div style={{ display: 'grid', gap: '1rem', gridTemplateColumns: 'repeat(3, minmax(0, 1fr))' }}>
<Stat label="Active workspaces">
<span className="ui-stat-value"><AnimatedNumber value={1234} /></span>
</Stat>
<Stat label="Deploy success">
<span className="ui-stat-value"><AnimatedNumber decimals={1} suffix="%" value={99.8} /></span>
</Stat>
<Stat label="Median build">
<span className="ui-stat-value"><AnimatedNumber suffix="s" value={42} /></span>
</Stat>
</div>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<div style="display: grid; gap: 1rem; grid-template-columns: repeat(3, minmax(0, 1fr));">
<lumen-stat label="Active workspaces">
<span class="ui-stat-value"><lumen-animated-number value="1234"></lumen-animated-number></span>
</lumen-stat>
<lumen-stat label="Deploy success">
<span class="ui-stat-value"><lumen-animated-number decimals="1" suffix="%" value={99.8}></lumen-animated-number></span>
</lumen-stat>
<lumen-stat label="Median build">
<span class="ui-stat-value"><lumen-animated-number suffix="s" value="42"></lumen-animated-number></span>
</lumen-stat>
</div><script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<div style="display: grid; gap: 1rem; grid-template-columns: repeat(3, minmax(0, 1fr));">
<lumen-stat label="Active workspaces">
<span class="ui-stat-value"><lumen-animated-number value="1234"></lumen-animated-number></span>
</lumen-stat>
<lumen-stat label="Deploy success">
<span class="ui-stat-value"><lumen-animated-number decimals="1" suffix="%" value={99.8}></lumen-animated-number></span>
</lumen-stat>
<lumen-stat label="Median build">
<span class="ui-stat-value"><lumen-animated-number suffix="s" value="42"></lumen-animated-number></span>
</lumen-stat>
</div>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add AnimatedNumberlumen add AnimatedNumberpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add AnimatedNumber --target reactlumen add AnimatedNumber --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add AnimatedNumber --target elementslumen add AnimatedNumber --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| Attribute | Values | Default | Description |
|---|---|---|---|
| value | number | required | Sets the final value announced to assistive technology and displayed after the animation. |
| from | number | 0 | Sets the visual starting value. |
| decimals | number | 0 | Sets the number of displayed decimal places. |
| locale | string | browser locale | Formats the value with Intl.NumberFormat. |
| prefix, suffix | string | "" | Adds stable text around the formatted number. |
| duration | "fast" | "standard" | "slow" | "slow" | Uses the shared Lumen motion duration. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |