@open-grid/theme 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Open Grid contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+# @open-grid/theme
+
+CSS variables and base theme for Open Grid.
+
+Use this package when applying the default Open Grid styling tokens to a styled UI package.
+
+## Install
+
+```bash
+npm install @open-grid/theme
+```
+
+## Usage
+
+```ts
+import "@open-grid/theme/css";
+```
+
+Import the theme before a framework UI package's CSS. Override the exposed `--og-*` custom properties on the styled `.og-grid` root to integrate Open Grid with an existing design system. The semantic `[data-open-grid]` scroller inherits those values, so toolbar controls and grid content use one token set.
+
+## Typed Tokens
+
+Use the optional `@open-grid/theme/tokens` entry point when product code owns theme values. It rejects unknown or empty token values at runtime and keeps CSS custom-property names out of application code:
+
+```ts
+import { createOpenGridThemeStyle } from "@open-grid/theme/tokens";
+
+const lightGridTheme = createOpenGridThemeStyle({
+  accent: "#155eef",
+  focus: "#0e9384",
+  surfaceSelected: "#eff4ff",
+  rowHeight: "36px",
+});
+```
+
+Pass the result to React's or Vue's grid-root `style` prop. React applications should cast the framework-neutral object to `CSSProperties`; Vue accepts it directly. Svelte's `style` prop is string-only, so use `createOpenGridThemeCssText`:
+
+```ts
+import { createOpenGridThemeCssText } from "@open-grid/theme/tokens";
+
+const darkGridTheme = createOpenGridThemeCssText({
+  accent: "#84adff",
+  focus: "#5fe9d0",
+  surfaceSelected: "#102a56",
+});
+```
+
+Define separate light and dark token sets when colors need different contrast. Apply the selected values to the styled grid root while keeping `data-og-theme` on the grid or product ancestor for the remaining bundled defaults. Use product CSS such as `.billing-workspace .og-grid { --og-accent: ...; }` when themes are static.
+
+## Customize
+
+Apply CSS overrides to the styled grid root:
+
+```css
+.billing-workspace .og-grid {
+  --og-font-family: Inter, sans-serif;
+  --og-accent: #7c3aed;
+  --og-focus: #0f766e;
+  --og-surface-selected: #f1edff;
+  --og-row-height: 36px;
+  --og-header-height: 40px;
+  --og-radius-lg: 4px;
+  --og-shadow-md: 0 12px 28px rgb(16 24 40 / 18%);
+}
+```
+
+The contract includes semantic surface, border, text, accent, danger, sizing, radius, shadow, and motion tokens. Existing base tokens such as `--og-surface`, `--og-border-color`, `--og-text`, and `--og-accent` remain supported; newer tokens let product themes distinguish raised, subtle, hover, selected, strong-border, and status states without overriding internal selectors.
+
+## Dark Theme
+
+Set `data-og-theme="dark"` on the grid or an ancestor. Dark tokens apply to the marked element itself and to styled or semantic grid descendants, including controls that are siblings of the semantic `[data-open-grid]` scroller. The bundled values remain fully overridable:
+
+```html
+<section data-og-theme="dark">
+  <div data-open-grid><!-- framework DataGrid output --></div>
+</section>
+```
+
+The theme sets `color-scheme` for native controls but does not define the surrounding application shell. Product applications remain responsible for applying matching page, toolbar, and panel colors and for choosing or persisting the active theme. A standalone unstyled `[data-open-grid]` still receives the base theme directly; inside a styled `.og-grid`, it inherits root overrides instead of redeclaring defaults.
+
+See the [project README](https://github.com/Goatshave/open-grid#readme) for framework UI installation and examples.

package/dist/index.css

@@ -0,0 +1,102 @@
+:where(.og-grid, [data-open-grid]:not(.og-grid [data-open-grid])) {
+  color-scheme: light;
+  --og-font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
+  --og-font-size: 13px;
+  --og-font-weight-medium: 500;
+  --og-font-weight-semibold: 600;
+  --og-border-color: #d8dee8;
+  --og-border: var(--og-border-color);
+  --og-border-subtle: #e9edf3;
+  --og-border-strong: #bcc6d4;
+  --og-surface: #ffffff;
+  --og-surface-raised: #ffffff;
+  --og-surface-muted: #f6f8fb;
+  --og-surface-subtle: #fbfcfe;
+  --og-surface-hover: #edf3ff;
+  --og-surface-selected: #e8f0ff;
+  --og-text: #172033;
+  --og-text-muted: #5f6b7f;
+  --og-text-subtle: #7f8a9d;
+  --og-accent: #2563eb;
+  --og-accent-hover: #1d4ed8;
+  --og-accent-soft: #e8f0ff;
+  --og-focus: #0f766e;
+  --og-danger: #c4322b;
+  --og-danger-soft: #fff1f0;
+  --og-row-height: 40px;
+  --og-header-height: 42px;
+  --og-control-height: 34px;
+  --og-radius-sm: 4px;
+  --og-radius: 6px;
+  --og-radius-lg: 8px;
+  --og-shadow-sm: 0 1px 2px rgb(16 24 40 / 6%);
+  --og-shadow-md: 0 10px 28px rgb(16 24 40 / 14%);
+  --og-shadow-pinned-left: 8px 0 14px -12px rgb(16 24 40 / 52%);
+  --og-shadow-pinned-right: -8px 0 14px -12px rgb(16 24 40 / 52%);
+  --og-transition: 140ms ease;
+  color: var(--og-text);
+  background: var(--og-surface);
+  font-family: var(--og-font-family);
+  font-size: var(--og-font-size);
+}
+
+:where(
+  [data-og-theme="dark"],
+  .og-grid[data-og-theme="dark"],
+  [data-open-grid][data-og-theme="dark"],
+  [data-og-theme="dark"] .og-grid,
+  [data-og-theme="dark"] [data-open-grid]:not(.og-grid [data-open-grid])
+) {
+  color-scheme: dark;
+  --og-border-color: #354052;
+  --og-border-subtle: #2b3443;
+  --og-border-strong: #58657a;
+  --og-surface: #171c25;
+  --og-surface-raised: #202733;
+  --og-surface-muted: #242c39;
+  --og-surface-subtle: #1b222d;
+  --og-surface-hover: #293a5a;
+  --og-surface-selected: #223b68;
+  --og-text: #edf1f7;
+  --og-text-muted: #aab4c3;
+  --og-text-subtle: #8793a5;
+  --og-accent: #79a8ff;
+  --og-accent-hover: #9bbdff;
+  --og-accent-soft: #243b66;
+  --og-focus: #5eead4;
+  --og-danger: #ff8a80;
+  --og-danger-soft: #482925;
+  --og-shadow-sm: 0 1px 2px rgb(0 0 0 / 24%);
+  --og-shadow-md: 0 14px 34px rgb(0 0 0 / 34%);
+  --og-shadow-pinned-left: 8px 0 14px -12px rgb(0 0 0 / 82%);
+  --og-shadow-pinned-right: -8px 0 14px -12px rgb(0 0 0 / 82%);
+}
+
+:where([data-open-grid] [role="row"]) {
+  min-height: var(--og-row-height);
+}
+
+:where([data-open-grid] [role="columnheader"]) {
+  min-height: var(--og-header-height);
+  color: var(--og-text-muted);
+  background: var(--og-surface-muted);
+  border-bottom: 1px solid var(--og-border-color);
+  font-weight: var(--og-font-weight-semibold);
+}
+
+:where([data-open-grid] [role="gridcell"]) {
+  border-bottom: 1px solid var(--og-border-subtle);
+}
+
+:where([data-open-grid] [role="gridcell"]:focus-visible),
+:where([data-open-grid] [role="columnheader"]:focus-visible) {
+  outline: 2px solid var(--og-focus);
+  outline-offset: -2px;
+}
+
+:where([data-open-grid] [data-pinned="left"]),
+:where([data-open-grid] [data-pinned="right"]) {
+  position: sticky;
+  z-index: 2;
+  background: inherit;
+}

package/dist/tokens.d.ts

@@ -0,0 +1,44 @@
+declare const openGridThemeTokens: {
+    readonly fontFamily: "--og-font-family";
+    readonly fontSize: "--og-font-size";
+    readonly fontWeightMedium: "--og-font-weight-medium";
+    readonly fontWeightSemibold: "--og-font-weight-semibold";
+    readonly borderColor: "--og-border-color";
+    readonly border: "--og-border";
+    readonly borderSubtle: "--og-border-subtle";
+    readonly borderStrong: "--og-border-strong";
+    readonly surface: "--og-surface";
+    readonly surfaceRaised: "--og-surface-raised";
+    readonly surfaceMuted: "--og-surface-muted";
+    readonly surfaceSubtle: "--og-surface-subtle";
+    readonly surfaceHover: "--og-surface-hover";
+    readonly surfaceSelected: "--og-surface-selected";
+    readonly text: "--og-text";
+    readonly textMuted: "--og-text-muted";
+    readonly textSubtle: "--og-text-subtle";
+    readonly accent: "--og-accent";
+    readonly accentHover: "--og-accent-hover";
+    readonly accentSoft: "--og-accent-soft";
+    readonly focus: "--og-focus";
+    readonly danger: "--og-danger";
+    readonly dangerSoft: "--og-danger-soft";
+    readonly rowHeight: "--og-row-height";
+    readonly headerHeight: "--og-header-height";
+    readonly controlHeight: "--og-control-height";
+    readonly radiusSmall: "--og-radius-sm";
+    readonly radius: "--og-radius";
+    readonly radiusLarge: "--og-radius-lg";
+    readonly shadowSmall: "--og-shadow-sm";
+    readonly shadowMedium: "--og-shadow-md";
+    readonly shadowPinnedLeft: "--og-shadow-pinned-left";
+    readonly shadowPinnedRight: "--og-shadow-pinned-right";
+    readonly transition: "--og-transition";
+};
+type OpenGridThemeToken = keyof typeof openGridThemeTokens;
+type OpenGridTheme = Partial<Record<OpenGridThemeToken, string>>;
+type OpenGridThemeCustomProperty = (typeof openGridThemeTokens)[OpenGridThemeToken];
+type OpenGridThemeStyle = Partial<Record<OpenGridThemeCustomProperty, string>>;
+declare function createOpenGridThemeStyle(theme: OpenGridTheme): OpenGridThemeStyle;
+declare function createOpenGridThemeCssText(theme: OpenGridTheme): string;
+
+export { type OpenGridTheme, type OpenGridThemeCustomProperty, type OpenGridThemeStyle, type OpenGridThemeToken, createOpenGridThemeCssText, createOpenGridThemeStyle, openGridThemeTokens };

package/dist/tokens.js

@@ -0,0 +1,67 @@
+// src/tokens.ts
+var openGridThemeTokens = {
+  fontFamily: "--og-font-family",
+  fontSize: "--og-font-size",
+  fontWeightMedium: "--og-font-weight-medium",
+  fontWeightSemibold: "--og-font-weight-semibold",
+  borderColor: "--og-border-color",
+  border: "--og-border",
+  borderSubtle: "--og-border-subtle",
+  borderStrong: "--og-border-strong",
+  surface: "--og-surface",
+  surfaceRaised: "--og-surface-raised",
+  surfaceMuted: "--og-surface-muted",
+  surfaceSubtle: "--og-surface-subtle",
+  surfaceHover: "--og-surface-hover",
+  surfaceSelected: "--og-surface-selected",
+  text: "--og-text",
+  textMuted: "--og-text-muted",
+  textSubtle: "--og-text-subtle",
+  accent: "--og-accent",
+  accentHover: "--og-accent-hover",
+  accentSoft: "--og-accent-soft",
+  focus: "--og-focus",
+  danger: "--og-danger",
+  dangerSoft: "--og-danger-soft",
+  rowHeight: "--og-row-height",
+  headerHeight: "--og-header-height",
+  controlHeight: "--og-control-height",
+  radiusSmall: "--og-radius-sm",
+  radius: "--og-radius",
+  radiusLarge: "--og-radius-lg",
+  shadowSmall: "--og-shadow-sm",
+  shadowMedium: "--og-shadow-md",
+  shadowPinnedLeft: "--og-shadow-pinned-left",
+  shadowPinnedRight: "--og-shadow-pinned-right",
+  transition: "--og-transition"
+};
+var themeTokenNames = new Set(Object.keys(openGridThemeTokens));
+function getValidatedThemeEntries(theme) {
+  const entries = [];
+  for (const [token, rawValue] of Object.entries(theme)) {
+    if (!themeTokenNames.has(token)) {
+      throw new TypeError(`Unknown Open Grid theme token: ${token}`);
+    }
+    if (typeof rawValue !== "string" || rawValue.trim().length === 0) {
+      throw new TypeError(`Open Grid theme token ${token} must be a non-empty string`);
+    }
+    entries.push([openGridThemeTokens[token], rawValue.trim()]);
+  }
+  return entries;
+}
+function createOpenGridThemeStyle(theme) {
+  return Object.fromEntries(getValidatedThemeEntries(theme));
+}
+function createOpenGridThemeCssText(theme) {
+  return getValidatedThemeEntries(theme).map(([property, value]) => {
+    if (/[;{}]/u.test(value)) {
+      throw new TypeError(`Open Grid theme token ${property} cannot contain CSS declaration delimiters`);
+    }
+    return `${property}: ${value}`;
+  }).join("; ");
+}
+export {
+  createOpenGridThemeCssText,
+  createOpenGridThemeStyle,
+  openGridThemeTokens
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@open-grid/theme",
+  "version": "0.1.0",
+  "description": "CSS variables, base themes, and typed product token adapters for Open Grid.",
+  "keywords": [
+    "data-grid",
+    "grid",
+    "table",
+    "css",
+    "theme"
+  ],
+  "homepage": "https://goatshave.github.io/open-grid/packages#theme",
+  "bugs": {
+    "url": "https://github.com/Goatshave/open-grid/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": [
+    "dist/index.css",
+    "src/index.css"
+  ],
+  "exports": {
+    ".": "./dist/index.css",
+    "./css": "./dist/index.css",
+    "./tokens": {
+      "types": "./dist/tokens.d.ts",
+      "import": "./dist/tokens.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup src/tokens.ts --format esm --dts --clean && cp src/index.css dist/index.css",
+    "check": "tsc --noEmit && test -f src/index.css",
+    "test": "pnpm build && node --test test/*.test.mjs",
+    "lint": "tsc --noEmit && test -f src/index.css"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Goatshave/open-grid.git",
+    "directory": "packages/theme"
+  }
+}