test-stpr-ui-kit
v1.0.1
Published
UI-kit package
Readme
Welcome to Test STPR UI ⚡️
- Works out of the box. Test STPR UI contains a set of polished React components that work out of the box.
Installing Test STPR UI
⚡️ Test STPR UI is made up of multiple components which you can import one by one.
Install the test-stpr-ui-kit package:
yarn add test-stpr-ui-kit
# or
npm install test-stpr-ui-kitThe package is ESM-only and has no install scripts — a normal install works without --ignore-scripts.
Runtime dependencies (clsx, date-fns, react-datepicker, etc.) are installed transitively with the package.
Static assets (fonts, web-ifc.wasm, etc.) are pre-bundled in dist/ at publish time.
Peer dependencies
Your app must satisfy:
react,react-dom— required;three,web-ifc— required only forIfcPreview/IfcViewer.
Getting set up
1. Design tokens (required)
Import once at the app entry (e.g. main.tsx):
import "test-stpr-ui-kit/styles/tokens.css";Component styles rely on --spui-* CSS variables from this file.
2. Components
import { Button } from "test-stpr-ui-kit";
const App = () => <Button>⚡️ Test STPR UI is very easy to use! ⚡️</Button>;Per-component CSS is loaded automatically via ESM side effects — no separate CSS import per component.
3. Vite + linked package (optional)
// consumer vite.config.ts
export default defineConfig({
optimizeDeps: {
exclude: ["test-stpr-ui-kit"],
},
});Documentation
Full guide (tokens, fonts, IFC assets, TypeScript): Storybook → Documentation → Introduction.
For library contributors
See CONTRIBUTING.md (components, stories, src/test-stpr-ui-kit.ts, release workflow).
