@case-framework/survey-ui 0.2.3 → 0.2.4

package/README.md

@@ -1,73 +1,51 @@
-# React + TypeScript + Vite
+# @case-framework/survey-ui
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+React UI components for CASE surveys, including the `SurveyEditor`.
 
-Currently, two official plugins are available:
+## SurveyEditor styling in a host project
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+Import the package stylesheet once in your app entry point:
 
-## React Compiler
-
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+```tsx
+import "@case-framework/survey-ui/css";
+```
 
-## Expanding the ESLint configuration
+If you only want the editor's default variable values as a tiny standalone asset, import:
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+```tsx
+import "@case-framework/survey-ui/editor-defaults.css";
+```
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+`@case-framework/survey-ui/css` already includes these defaults, so the standalone file is only needed when the host wants a separate variables-only layer.
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+If the host app uses Tailwind CSS v4, add the package as a source in the host global CSS file so Tailwind also scans the editor package:
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```css
+@import "tailwindcss";
+@source "../node_modules/@case-framework/survey-ui/dist";
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+Override the editor-specific CSS variables on the `.survey-editor` scope in the host stylesheet:
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+```css
+.survey-editor {
+  --main-bg-color: oklch(98.5% 0 0);
+  --main-bg-dot-color: oklch(85% 0 0);
+  --main-bg-dot-grid-size: calc(var(--spacing, 0.25rem) * 5);
 
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+  --footer-bg-color: oklch(37.3% 0.034 259.733);
+  --footer-text-color: oklch(98.5% 0 0);
+  --footer-height: calc(var(--spacing, 0.25rem) * 6);
+}
 ```
+
+Available editor-scoped variables:
+
+- `--main-bg-color`
+- `--main-bg-dot-color`
+- `--main-bg-dot-grid-size`
+- `--footer-bg-color`
+- `--footer-text-color`
+- `--footer-height`
+
+The editor also uses the shared UI theme tokens from the package stylesheet, so you can override variables such as `--background`, `--foreground`, `--card`, `--primary`, `--muted`, `--accent`, `--border`, `--input`, and `--ring` if you want the rest of the editor chrome to match your host theme.

package/dist/survey-editor-defaults.css

@@ -0,0 +1,9 @@
+.survey-editor {
+    --main-bg-color: oklch(98.5% 0 0);
+    --main-bg-dot-color: oklch(85% 0 0);
+    --main-bg-dot-grid-size: calc(var(--spacing, 0.25rem) * 5);
+
+    --footer-bg-color: oklch(37.3% 0.034 259.733);
+    --footer-text-color: oklch(98.5% 0 0);
+    --footer-height: calc(var(--spacing, 0.25rem) * 6);
+}