Docs · Start here
Getting started
Import a component, put it on your page and tweak its props. In five minutes you'll have something moving.
On this page
1. Import and use a component
Pick the import that matches how you installed it. The rest of the code is the same:
import { DecipherText } from "furin-ui";
export default function Headline() {
return (
<h1 style={{ fontSize: 48 }}>
<DecipherText text="Hello, furin" />
</h1>
);
}import { DecipherText } from "@/components/furin/decipher-text/DecipherText";
export default function Headline() {
return (
<h1 style={{ fontSize: 48 }}>
<DecipherText text="Hello, furin" />
</h1>
);
}Decipher Text (DecipherText in code) shows the text scrambled and settles it letter by letter, on mount and every time you hover it. It inherits color, size and font from wherever you place it.
2. Tweak it with props
Every component has its own props, with default values: you can start with none and change only what you need. This example uses Odometer, which rolls a number up to its value:
import { Odometer } from "furin-ui";
<Odometer value={1250} prefix="$" suffix=" USD" style={{ fontSize: 32 }} />When value changes, the columns roll to the new number. Every component's props are in a table on its page, with their type, default value and what they do. Right there, the Live controls panel lets you move them and see the result live before you copy anything.
3. Add an animated background
Components in the Backgrounds category fill their container. Give the container position: relative and a height, and put your content inside the background as children:
import { Aurora, DecipherText } from "furin-ui";
export default function Hero() {
return (
<section style={{ position: "relative", minHeight: 360 }}>
<Aurora>
<h1 style={{ fontSize: 48, color: "white" }}>
<DecipherText text="Hello, furin" />
</h1>
</Aurora>
</section>
);
}Aurora draws with WebGL. With speed={0} it freezes, and if the visitor asked for less motion in their system, it stays still on its own (more on accessibility).
Next steps
- Props and customization: className, style and CSS variables.
- Next.js and SSR or Vite, Remix and Astro: what changes depending on your framework.
- Components by category: find the one you're after.
- Performance: how many heavy backgrounds fit on a page.
Spot a mistake or something missing? Email us at contacto@furin.dev.