dibk-design 10.5.8 → 11.1.0

package/README.md

@@ -1,49 +1,42 @@
 # DIBK design
 
-Shared components for DIBK applications
+Shared React component library for DIBK applications — 43 components, design tokens, and themes, published as the [`dibk-design`](https://www.npmjs.com/package/dibk-design) npm package.
 
-## Getting Started
+Component documentation (Storybook): https://arkitektum.github.io/dibk-design/
 
-1.  **Install Dependencies**
+## Using the package
+
+1.  **Install**
 
-    This project uses [pnpm](https://pnpm.io/) as the package manager.
     ```bash
-    pnpm install
+    npm install dibk-design
     ```
 
-2.  **Run Storybook for Development**
+    Peer dependencies (must be installed in your app): `react` (18 or 19), `react-dom`, `react-router-dom` (6.4+ or 7).
 
-    To view and work on components in isolation, run the Storybook development server:
-    ```bash
-    pnpm run storybook
-    ```
-    This will open Storybook in your browser, usually at `http://localhost:6006`.
+2.  **Import the component styles**
 
-## Building for Production
+    All compiled component styles ship in a single CSS file that your app must import once (e.g. in your global CSS or app entry):
 
-When you need to create a distributable version of the library or the Storybook site, use the following commands.
+    ```css
+    @import "dibk-design/dibk-design.css";
+    ```
 
-### Build Library
-Bundles the library for production and generates TypeScript types. The output is saved to the `/dist` folder.
-```bash
-pnpm run build
-```
+3.  **Use the components**
 
-### Build TypeScript Types
-Only generates the TypeScript declaration files (`.d.ts`).
-```bash
-pnpm run build:types
-```
+    ```jsx
+    import { Button } from "dibk-design";
 
-### Build Storybook
-Builds the Storybook as a static web application. The output is saved to the `/storybook-static` folder.
-```bash
-pnpm run build-storybook
-```
+    const Example = () => (
+      <Button onClick={() => {}} size="small" color="primary">
+        I'm a button
+      </Button>
+    );
+    ```
 
 ## Styles & tokens
 
-This package ships two CSS entrypoints:
+In addition to `dibk-design/dibk-design.css` (component styles), the package ships two design-token entrypoints:
 
 - `dibk-design/theme.css` — Tailwind-friendly theme tokens (via `@theme`)
 - `dibk-design/tokens.css` — plain CSS variables for non-Tailwind apps
@@ -55,6 +48,7 @@ Import the theme tokens in your global CSS:
 ```css
 @import "tailwindcss";
 @import "dibk-design/theme.css";
+@import "dibk-design/dibk-design.css";
 ```
 
 ### Use without Tailwind
@@ -63,33 +57,88 @@ Import the plain tokens instead:
 
 ```css
 @import "dibk-design/tokens.css";
+@import "dibk-design/dibk-design.css";
 ```
 
 ## Use with Next.js
 
-1. Import the CSS entrypoint in your `globals.css`
+1. Import the CSS entrypoints in your `globals.css`
 
 ```css
 @import "tailwindcss";
 @import "dibk-design/theme.css";
+@import "dibk-design/dibk-design.css";
 ```
 
-2. Import component from the library
+2. Import components from the library
 
 ```jsx
-"use client"
-import React from 'react'
-import { Button } from 'dibk-design'
+"use client";
+import React from "react";
+import { Button } from "dibk-design";
 
 const Home = () => {
   return (
     <main>
-      <Button onClick={() => {}} size="small" color="primary" content="Button">
-          I'm a button
+      <Button onClick={() => {}} size="small" color="primary">
+        I'm a button
       </Button>
     </main>
-  )
-}
+  );
+};
+
+export default Home;
+```
+
+## Developing the library
+
+This project uses [pnpm](https://pnpm.io/) as the package manager.
+
+1.  **Install dependencies**
+
+    ```bash
+    pnpm install
+    ```
+
+2.  **Run Storybook for development**
+
+    To view and work on components in isolation, run the Storybook development server:
+    ```bash
+    pnpm run storybook
+    ```
+    This will open Storybook in your browser, usually at `http://localhost:6006`.
+
+## Building for production
+
+### Build library
+
+Type-checks, bundles the library (ES/CJS + a bundled `index.d.ts`), and copies the token files. The output is saved to the `/dist` folder.
+```bash
+pnpm run build:lib
+```
+
+### Build Storybook
+
+Builds the Storybook as a static web application. The output is saved to the `/storybook-static` folder.
+```bash
+pnpm run build:storybook
+```
+
+### Build everything
+
+Builds both the library and the Storybook site:
+```bash
+pnpm run build
+```
+
+## Testing local changes in a consuming app
+
+Use [yalc](https://github.com/wclr/yalc) to test the built package in another app without publishing:
+
+```bash
+# In dibk-design — after making changes:
+pnpm run build:lib && npx yalc push
 
-export default Home
+# In the consuming app — first time only:
+npx yalc add dibk-design
 ```