@dcs-tech/ui 0.4.0 → 0.7.0

package/README.md

@@ -69,6 +69,33 @@ The table's runtime dependencies (`@tanstack/react-table`, `@tanstack/react-virt
 `@tanstack/match-sorter-utils`, `exceljs`, `pdfmake` — loaded on the first PDF export —
 and `react-icons`) install with the package.
 
+## Files and the background worker
+
+Exports (DataTable, chart images, your own reports) run through one file engine that
+`UIProvider` sets up. Excel and PDF files build in a **background worker**, so a large
+export does not freeze the page.
+
+The worker ships as its own file and imports `exceljs` and `pdfmake` by package name, so
+**your bundler must treat it as a worker entry**:
+
+- **Vite** and **webpack 5**: nothing to do. They follow the package's
+  `new Worker(new URL(…, import.meta.url))` and bundle the worker themselves.
+- **Anything else**: build a worker from `@dcs-tech/ui/file-worker` with your bundler and hand it
+  to the engine:
+
+  ```ts
+  // file.worker.ts — bundled by your setup as a module worker
+  import '@dcs-tech/ui/file-worker';
+  ```
+
+  ```tsx
+  <UIProvider fileEngine={{ createWorker: () => new Worker('/assets/file.worker.js', { type: 'module' }) }}>
+  ```
+
+If a worker cannot start, the engine builds the same file on the main thread instead.
+`fileEngine={{ workers: 'off' }}` always uses the main thread. Large PDF fonts (a script font)
+belong on the engine, so they reach each worker once: `fileEngine={{ pdfFonts: { fonts, vfs } }}`.
+
 ## Theming
 
 Every colour, size and spacing value is a CSS custom property. Override them on