Installation
Inkline ships one package per framework. Install the one that matches your app — you never install more than one, and there is nothing to configure afterwards.
Pick your framework in the Framework select. The steps below then show its package, the peer dependency it expects, and the import that loads the component styles.
Install the package
npm install @inkline/react
Peer dependency: react 18 or newer.
Use pnpm add, yarn add or bun add if that is your package manager — the
package name does not change.
The package brings one runtime dependency with it, @styleframe/runtime, which
resolves the design tokens the components read. Everything else is a peer
dependency you already have.
Load the styles
Inkline components carry classes, not inline styles. Import the stylesheet once, at the entry point of your app, before anything renders.
import "@inkline/react/css";
That stylesheet is the default theme. Once you want your own brand colors, spacing or radii, you stop importing it and generate your own — one config file, covered in Theming.
/css entry
point. Framework support lists every
such difference in one table.Verify the install
Render one component. If it appears and it is styled, you are done.
import { IButton } from "@inkline/react";
export default function App() {
return <IButton label="It works" color="primary" />;
}
A styled button means the package resolved and the stylesheet loaded. An
unstyled button — plain browser default, no color — means the component
resolved but the stylesheet did not: check that the /css import runs before
your app renders.
Next steps
- Your first component — props, slots and the headless layer.
- Theming — replace the default theme with your own.
- Framework support — per-target differences.