Income Stream, animated React component
Income drawn as a stream. Each month's money flows as a band mirrored about its centre, the steady salary inside and the extras around it, breathing a little as it flows. Move along it and a hairline picks out the month: the total rolls to it, the month before is compared and the band brightens under the line.
- Pro
- Dashboards
- Hover
- Spring
Ticks softly as you use it. Sound is off on this site until you switch it on.
Play with it
Move the controls and watch it change. Copy code gives you a snippet with only the props you changed.
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| title | string | "Income" | Heading above the stream. |
| sources | IncomeSource[] | DEFAULT_SOURCES | The income sources drawn as bands, each as { id, name, color }. |
| months | IncomeMonth[] | DEFAULT_MONTHS | One entry per month as { month, values }, where values holds an amount for each source id. |
| currency | string | "$" | Currency symbol shown before amounts. |
| onMonthChange | (index: number) => void | — | Called with the month index as the pointer or the arrow keys move along the stream. |
| volume | number | 0.6 | Sound level, 0 to 1. |
| autoplay | boolean | false | Plays a short demo by itself until the visitor touches it. Never runs under reduced motion. |
| className | string | "" | Extra classes for the outer element. |
| enableSound | boolean | true | Plays interface sounds on interaction. They follow the sound switch (setSoundsEnabled, on by default) and stay silent on hover. Autoplay makes the same sounds once the visitor has used the page. Pass false to silence this component. |
Add it to your project
- 1
Set up your project once
You need a Next.js project with Tailwind CSS and the
@/import alias. In its root folder, run this once. It createscomponents.jsonand thecn()helper insrc/lib/utils.ts:npx shadcn@latest init -d
Starting from nothing? The Quick Start walks through the whole thing.
- 2
Connect the registry with your API key
Income Stream is a Pro item, so the CLI has to send your API key. Do this once per project:
- Create a key at nexus-ui.com/dashboard/api-key. Copy it straight away: it starts with
nxs_and is shown only once. - In your project root, next to
package.json, create a file named.env.localwith this line, using your own key:NEXUS_API_KEY=nxs_your_key_here
- Open
components.jsonand add this entry inside the outermost braces, next to"aliases". Leave{name}and${NEXUS_API_KEY}exactly as written; the CLI fills them in:"registries": { "@nexus-labs": { "url": "https://www.nexus-ui.com/api/registry/{name}", "headers": { "Authorization": "Bearer ${NEXUS_API_KEY}" } } }
- Create a key at nexus-ui.com/dashboard/api-key. Copy it straight away: it starts with
How Income Stream works
Income as a stream. Each month's money flows left to right as a band that swells and narrows with the total, mirrored about its centre, with the steady part on the inside and the extras around it. The band breathes a little as it flows. Move along it (or use the arrow keys) and a hairline picks out the month: the total rolls to it, the month beside it is compared, and the band brightens under the line while the rest dims.
The source, the install command and the build prompt come with Pro.
Income Stream questions
Does it make sound, and how do I turn it off?
Ticks softly as you use it. Sounds are synthesised with the Web Audio API, so there are no audio files, and they only play after a click or key press. Pass `enableSound={false}` to silence this component, or call `setSoundsEnabled(false)` from `@/lib/ui-sounds` to switch every sound off at once. The CLI installs `@/lib/ui-sounds` with the component.