Docs · Start here
Installation
Choose how to bring Furin into your project: with npm, with the shadcn CLI or by copying the code.
On this page
Requirements
- React 18 or later, with
react-dom. - A bundler that can import
.cssfiles: Next.js, Vite, Remix, Astro, webpack, Parcel, esbuild or Bun. - Node 18 or later to install. The npm package is ESM-only and ships its TypeScript types.
- You don't need Tailwind or any other library.
Which method to pick
| Method | It's for you if… | What you get | Available for |
|---|---|---|---|
| npm | you want to use the components without touching their code | The furin-ui package with the 92 free components | Free |
| shadcn | you want the code inside your project so you can edit it | A .tsx and a .css in components/furin/<slug>/ | Free (public registry) and Pro (private registry, with a license) |
| By hand | you use neither shadcn nor npm | You copy the two files yourself | Free |
| .zip | you use Pro and don't use shadcn | Your license's components in a folder | Pro |
With npm
Install the package with your package manager of choice:
npm i furin-uipnpm add furin-uiyarn add furin-uibun add furin-uiImport
Import the components you need. Each one ships its own CSS and imports it for you:
import { DecipherText, Odometer, Aurora } from "furin-ui";Load only what you use
To load a single component, import by path. The path name is the one on its catalog page (for example furin-ui/decipher-text or furin-ui/liquid-chrome):
import DecipherText from "furin-ui/decipher-text";A single stylesheet
If you'd rather load all the CSS once (for example in your layout), import the full stylesheet. It includes the CSS for the 92 free components:
import "furin-ui/estilos.css";Pro components aren't in this package: they install with your license (Furin Pro).
With shadcn
Every free component is in Furin's public registry. The shadcn CLI copies its code into your project, with no new dependencies:
npx shadcn@latest add https://furin.dev/r/decipher-text.jsonReplace decipher-text with the component name in its page URL (for example liquid-chrome). Two files are created together, the .tsx and its .css, in components/furin/decipher-text/. Import it like any local component:
import { DecipherText } from "@/components/furin/decipher-text/DecipherText";The @/ alias is shadcn's default; adjust it if yours is different.
Note
This method is for projects that already use shadcn (with a components.json). If that's not you, use npm or copy the files by hand. Pro components also install through shadcn, from a private registry: see how.
By hand
- Open a free component's page and go to the Code tab.
- Copy the
.tsxand the.cssinto the same folder of your project: the.tsximports its CSS with a relative path. - Import it from that folder, like any local component.
Pro components don't show their code in the catalog: you get them with your license, through shadcn or as a .zip.
Check that it works
Drop a component into a page and reload:
<DecipherText text="It works" />The letters should scramble and then settle. If nothing happens, or you get an error, check Troubleshooting.
Spot a mistake or something missing? Email us at contacto@furin.dev.