@equinor/cpl-theme-react 0.0.1

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Equinor ASA
+
+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,13 @@
+[<-- Go back](../../README.md)
+
+# @equinor/cpl-theme-react
+
+## Installation
+
+```sh
+yarn add @equinor/cpl-theme-react
+```
+
+## Components
+
+- `ThemeProvider` - A provider component which will only be rendered on the client side that wraps your application and manages theme mode state.

package/dist/index.css

@@ -0,0 +1,41 @@
+/* src/styles.css */
+:root[data-equinor-cpl-theme=light] {
+  --color-text: rgba(19, 38, 52, 1);
+}
+:root[data-equinor-cpl-theme=dark] {
+  --background-default: rgba(19, 38, 52, 1);
+  --background-raised: #243746;
+  --color-text: #ffffff;
+  --color-text-secondary: rgba(222, 229, 231, 1);
+  --color-text-tertiary: rgba(156, 166, 172, 1);
+  --color-text-static-icons-primary: rgba(255, 255, 255, 1);
+  --color-text-static-primary-black: rgba(0, 0, 0, 1);
+  --color-text-static-icons-secondary: rgba(222, 229, 231, 1);
+  --color-text-static-icons-tertiary: rgba(156, 166, 172, 1);
+  --interactive-primary-resting: rgba(151, 202, 206, 1);
+  --interactive-primary-hover-alt: rgba(173, 226, 230, 0.1);
+  --interactive-primary-hover: rgba(173, 226, 230, 1);
+  --interactive-secondary-resting: rgba(222, 229, 231, 1);
+  --interactive-secondary-highlight: rgba(255, 255, 255, 0.1);
+  --interactive-secondary-hover: rgba(255, 255, 255, 1);
+  --interactive-focus-border: #97cace;
+  --interactive-disabled-text: #637583;
+  --interactive-disabled-border: #405462;
+  --interactive-focus: rgba(0, 112, 121, 1);
+  --interactive-danger-text: rgba(255, 102, 112, 1);
+  --interactive-warning-text: rgba(255, 198, 122, 1);
+  --interactive-success-text: rgba(161, 218, 160, 1);
+  --interactive-table-header-fill-resting: #243746;
+  --line-color: #444c52;
+  --line-color-2: #394955;
+  --background-lighten: rgba(2, 1, 1, 0.16);
+  --eds-color-surface-input: rgba(0, 0, 0, 0.28);
+  --eds-color-text-input-placeholder: rgba(100, 114, 125, 1);
+  --eds-color-icon-interactive: rgba(166, 175, 181, 1);
+  --eds-color-text-static: rgba(166, 175, 181, 1);
+  --eds-color-text-static-2: rgba(194, 200, 204, 1);
+}
+body {
+  background-color: var(--background-default);
+  color: var(--color-text);
+}

package/dist/index.d.mts

@@ -0,0 +1,87 @@
+import { tokens } from '@equinor/eds-tokens';
+import React from 'react';
+
+/**
+ * Utility for deep partial
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type EdsTokensType = typeof tokens;
+type CplTokensType = DeepPartial<EdsTokensType>;
+
+type ThemeMode = 'light' | 'dark' | undefined;
+type CustomToken = Record<string, string>;
+type ThemeContextType = {
+    mode: ThemeMode;
+    tokens?: CplTokensType & {
+        custom?: CustomToken;
+    };
+    toggleTheme: (mode: ThemeMode) => void;
+};
+/**
+ * `ThemeContext`
+ * The context used to provide and consume the current theme mode ("light" | "dark" | undefined).
+ * Exposes `mode` as the current theme and `toggleTheme` as a function to switch themes.
+ *
+ * Usage:
+ * ```tsx
+ *  const { mode, toggleTheme, tokens } = useTheme();
+ * ```
+ */
+declare const ThemeContext: React.Context<ThemeContextType | undefined>;
+type ThemeProviderProps = {
+    mode?: ThemeMode;
+    children: React.ReactNode | null | undefined;
+    tokens?: CplTokensType & {
+        custom?: CustomToken;
+    };
+};
+/**
+ * `ThemeProvider`
+ *
+ * A provider component which will only be rendered on the client side that wraps your application and manages theme mode state.
+ * It takes an initial `mode` as an optional prop (default is undefined).
+ *
+ * - Sets a `data-equinor-cpl-theme` attribute on the document root to enable theme-based styling in CSS.
+ * - Exposes `mode`, tokens (if defined ), and `toggleTheme` for managing theme switching.
+ *
+ * Usage:
+ * ```tsx
+ * <ThemeProvider mode="dark" tokens={{custom:{},ui:{},...}} >
+ *   <App />
+ * </ThemeProvider>
+ *
+ * ```
+ */
+declare const ThemeProvider: ({ children, mode, tokens, }: ThemeProviderProps) => React.JSX.Element;
+
+/**
+ * `useTheme`
+ * A custom hook to access the current theme and theme toggle function.
+ *
+ * - This hook returns `mode` (the current theme, either "light" or "dark") ,
+ *   tokens ( to access the  tokens in JSON format, if defined)
+ *   and `toggleTheme` (a function to switch themes).
+ *
+ * - Must be used within a `ThemeProvider`, or it will throw an error.
+ *
+ * Usage:
+ * ```tsx
+ * const { mode, toggleTheme, tokens } = useTheme();
+ * toggleTheme("dark"); // Example: Switch to dark mode
+ * ```
+ *
+ * @throws Error if `useTheme` is called outside of a `ThemeProvider`.
+ */
+declare const useTheme: () => {
+    mode: "light" | "dark" | undefined;
+    tokens?: CplTokensType & {
+        custom?: {
+            [x: string]: string;
+        };
+    };
+    toggleTheme: (mode: "light" | "dark" | undefined) => void;
+};
+
+export { type CplTokensType, type DeepPartial, ThemeContext, ThemeProvider, useTheme };

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import { tokens } from '@equinor/eds-tokens';
+import React from 'react';
+
+/**
+ * Utility for deep partial
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type EdsTokensType = typeof tokens;
+type CplTokensType = DeepPartial<EdsTokensType>;
+
+type ThemeMode = 'light' | 'dark' | undefined;
+type CustomToken = Record<string, string>;
+type ThemeContextType = {
+    mode: ThemeMode;
+    tokens?: CplTokensType & {
+        custom?: CustomToken;
+    };
+    toggleTheme: (mode: ThemeMode) => void;
+};
+/**
+ * `ThemeContext`
+ * The context used to provide and consume the current theme mode ("light" | "dark" | undefined).
+ * Exposes `mode` as the current theme and `toggleTheme` as a function to switch themes.
+ *
+ * Usage:
+ * ```tsx
+ *  const { mode, toggleTheme, tokens } = useTheme();
+ * ```
+ */
+declare const ThemeContext: React.Context<ThemeContextType | undefined>;
+type ThemeProviderProps = {
+    mode?: ThemeMode;
+    children: React.ReactNode | null | undefined;
+    tokens?: CplTokensType & {
+        custom?: CustomToken;
+    };
+};
+/**
+ * `ThemeProvider`
+ *
+ * A provider component which will only be rendered on the client side that wraps your application and manages theme mode state.
+ * It takes an initial `mode` as an optional prop (default is undefined).
+ *
+ * - Sets a `data-equinor-cpl-theme` attribute on the document root to enable theme-based styling in CSS.
+ * - Exposes `mode`, tokens (if defined ), and `toggleTheme` for managing theme switching.
+ *
+ * Usage:
+ * ```tsx
+ * <ThemeProvider mode="dark" tokens={{custom:{},ui:{},...}} >
+ *   <App />
+ * </ThemeProvider>
+ *
+ * ```
+ */
+declare const ThemeProvider: ({ children, mode, tokens, }: ThemeProviderProps) => React.JSX.Element;
+
+/**
+ * `useTheme`
+ * A custom hook to access the current theme and theme toggle function.
+ *
+ * - This hook returns `mode` (the current theme, either "light" or "dark") ,
+ *   tokens ( to access the  tokens in JSON format, if defined)
+ *   and `toggleTheme` (a function to switch themes).
+ *
+ * - Must be used within a `ThemeProvider`, or it will throw an error.
+ *
+ * Usage:
+ * ```tsx
+ * const { mode, toggleTheme, tokens } = useTheme();
+ * toggleTheme("dark"); // Example: Switch to dark mode
+ * ```
+ *
+ * @throws Error if `useTheme` is called outside of a `ThemeProvider`.
+ */
+declare const useTheme: () => {
+    mode: "light" | "dark" | undefined;
+    tokens?: CplTokensType & {
+        custom?: {
+            [x: string]: string;
+        };
+    };
+    toggleTheme: (mode: "light" | "dark" | undefined) => void;
+};
+
+export { type CplTokensType, type DeepPartial, ThemeContext, ThemeProvider, useTheme };

package/dist/index.js

@@ -0,0 +1,115 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  ThemeContext: () => ThemeContext,
+  ThemeProvider: () => ThemeProvider,
+  useTheme: () => useTheme
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/tokens.ts
+var tokens = {
+  /**
+   * Generic CplTokens in json format which can be overridden for project specific
+   */
+  /**
+     @ Example
+       colors:{
+        ui:{
+          background__default: {
+            hex:''
+            hsla:''
+            rgba:''
+          }
+        }
+      }
+    */
+};
+var tokens_default = tokens;
+
+// src/ThemeProvider.tsx
+var import_react = __toESM(require("react"));
+var attributeSelector = `data-equinor-cpl-theme`;
+var ThemeContext = import_react.default.createContext(void 0);
+var ThemeProvider = ({
+  children,
+  mode = void 0,
+  tokens: tokens2 = tokens_default
+}) => {
+  const [initialMode, setInitialModeMode] = import_react.default.useState(mode);
+  const toggleTheme = import_react.default.useCallback((newMode) => setInitialModeMode(newMode), []);
+  import_react.default.useEffect(() => {
+    if (initialMode) {
+      document.documentElement.setAttribute(attributeSelector, initialMode);
+    }
+  }, [initialMode]);
+  const applyCustomTokensToCSS = import_react.default.useCallback(
+    (props) => {
+      const selector = `:root[${attributeSelector}="${mode}"]`;
+      for (const stylesheet of Array.from(document.styleSheets)) {
+        try {
+          for (const rule of Array.from(stylesheet.cssRules)) {
+            if (rule instanceof CSSStyleRule && rule.selectorText === selector) {
+              Object.keys(props.tokens).forEach((key) => {
+                rule.style.setProperty(`${key}`, props.tokens[key]);
+              });
+            }
+          }
+        } catch (_) {
+        }
+      }
+    },
+    [mode]
+  );
+  import_react.default.useEffect(() => {
+    if (initialMode && tokens2.custom) {
+      applyCustomTokensToCSS({ tokens: tokens2.custom, mode: initialMode });
+    }
+  }, [tokens2, initialMode, applyCustomTokensToCSS]);
+  return /* @__PURE__ */ import_react.default.createElement(ThemeContext.Provider, { value: { mode: initialMode, toggleTheme, tokens: tokens2 } }, children);
+};
+
+// src/useTheme.ts
+var import_react2 = require("react");
+var useTheme = () => {
+  const context = (0, import_react2.useContext)(ThemeContext);
+  if (!context) {
+    throw new Error("useTheme must be used within a ThemeProvider");
+  }
+  return context;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ThemeContext,
+  ThemeProvider,
+  useTheme
+});

package/dist/index.mjs

@@ -0,0 +1,76 @@
+// src/tokens.ts
+var tokens = {
+  /**
+   * Generic CplTokens in json format which can be overridden for project specific
+   */
+  /**
+     @ Example
+       colors:{
+        ui:{
+          background__default: {
+            hex:''
+            hsla:''
+            rgba:''
+          }
+        }
+      }
+    */
+};
+var tokens_default = tokens;
+
+// src/ThemeProvider.tsx
+import React from "react";
+var attributeSelector = `data-equinor-cpl-theme`;
+var ThemeContext = React.createContext(void 0);
+var ThemeProvider = ({
+  children,
+  mode = void 0,
+  tokens: tokens2 = tokens_default
+}) => {
+  const [initialMode, setInitialModeMode] = React.useState(mode);
+  const toggleTheme = React.useCallback((newMode) => setInitialModeMode(newMode), []);
+  React.useEffect(() => {
+    if (initialMode) {
+      document.documentElement.setAttribute(attributeSelector, initialMode);
+    }
+  }, [initialMode]);
+  const applyCustomTokensToCSS = React.useCallback(
+    (props) => {
+      const selector = `:root[${attributeSelector}="${mode}"]`;
+      for (const stylesheet of Array.from(document.styleSheets)) {
+        try {
+          for (const rule of Array.from(stylesheet.cssRules)) {
+            if (rule instanceof CSSStyleRule && rule.selectorText === selector) {
+              Object.keys(props.tokens).forEach((key) => {
+                rule.style.setProperty(`${key}`, props.tokens[key]);
+              });
+            }
+          }
+        } catch (_) {
+        }
+      }
+    },
+    [mode]
+  );
+  React.useEffect(() => {
+    if (initialMode && tokens2.custom) {
+      applyCustomTokensToCSS({ tokens: tokens2.custom, mode: initialMode });
+    }
+  }, [tokens2, initialMode, applyCustomTokensToCSS]);
+  return /* @__PURE__ */ React.createElement(ThemeContext.Provider, { value: { mode: initialMode, toggleTheme, tokens: tokens2 } }, children);
+};
+
+// src/useTheme.ts
+import { useContext } from "react";
+var useTheme = () => {
+  const context = useContext(ThemeContext);
+  if (!context) {
+    throw new Error("useTheme must be used within a ThemeProvider");
+  }
+  return context;
+};
+export {
+  ThemeContext,
+  ThemeProvider,
+  useTheme
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@equinor/cpl-theme-react",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "@equinor/eds-icons": "^0.21.0",
+    "@equinor/eds-tokens": "^0.9.2"
+  },
+  "devDependencies": {
+    "@equinor/eds-core-react": "^0.42.1",
+    "@storybook/react": "^8.1.11",
+    "@storybook/test": "^8.1.11",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@types/styled-components": "^5.1.34",
+    "eslint": "^8.56.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "styled-components": "^6.1.11",
+    "tsup": "^8.1.0",
+    "eslint-config-custom": "0.0.5",
+    "tsconfig": "0.0.1"
+  },
+  "peerDependencies": {
+    "@equinor/eds-core-react": ">=0.42.1",
+    "react": ">=18.2.0",
+    "react-dom": ">=18.2.0",
+    "styled-components": ">=5.3.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --external react",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts --external react",
+    "lint": "TIMING=1 eslint . --fix"
+  }
+}