@equinor/eds-tokens 2.2.0 → 2.3.0-beta.0

package/instructions/typography.md

@@ -0,0 +1,161 @@
+---
+applyTo: '**'
+---
+
+# Typography System
+
+This guide introduces the EDS typography system -- how typographic properties are tokenised, controlled via data attributes, and consumed in CSS and TypeScript.
+
+## Core Concepts
+
+Typography in EDS is broken into five independent axes. Each axis has its own set of CSS variables and can be switched at runtime using a `data-*` attribute.
+
+| Axis | Data attribute | Modes |
+|------|---------------|-------|
+| **Font family** | `data-font-family` | `header`, `ui` |
+| **Font size** | `data-font-size` | `xs`, `sm`, `md`, `lg`, `xl`, `2xl`, `3xl`, `4xl`, `5xl`, `6xl` |
+| **Font weight** | `data-font-weight` | `lighter`, `normal`, `bolder` |
+| **Line height** | `data-line-height` | `default`, `squished` |
+| **Tracking** | `data-tracking` | `tight`, `normal`, `wide`, `loose` |
+
+### How It Works
+
+Each axis resolves to a single active CSS variable:
+
+- `--eds-typography-font-family`
+- `--eds-typography-font-size`
+- `--eds-typography-font-weight`
+- `--eds-typography-line-height`
+- `--eds-typography-tracking`
+
+The data attributes switch which underlying mode is mapped to these variables. Font size also sets companion variables for icon sizing and gap spacing that scale with the text.
+
+## CSS Variables
+
+### Import
+
+```css
+@import '@equinor/eds-tokens/css/variables';
+```
+
+### Usage
+
+Apply data attributes to set the typographic context, then use the CSS variables in your styles:
+
+```html
+<div data-font-family="ui" data-font-size="md" data-font-weight="normal">
+  <p>Body text using UI font at medium size</p>
+</div>
+```
+
+```css
+.text {
+  font-family: var(--eds-typography-font-family);
+  font-size: calc(var(--eds-typography-font-size) * 1px);
+  font-weight: var(--eds-typography-font-weight);
+  line-height: calc(var(--eds-typography-line-height) * 1px);
+  letter-spacing: calc(var(--eds-typography-tracking) * 1px);
+}
+```
+
+### Companion Variables
+
+When `data-font-size` is set, additional variables are resolved automatically:
+
+```css
+.icon-next-to-text {
+  /* Icon size and gap scale with font size */
+  width: calc(var(--eds-typography-icon-size) * 1px);
+  gap: calc(var(--eds-typography-gap-horizontal) * 1px);
+}
+```
+
+### Switching Modes
+
+Change typographic properties by updating data attributes -- no CSS changes needed:
+
+```html
+<!-- Heading context -->
+<h2 data-font-family="header" data-font-size="2xl" data-font-weight="bolder">
+  Section Title
+</h2>
+
+<!-- Body context -->
+<p data-font-family="ui" data-font-size="md" data-font-weight="normal">
+  Paragraph text
+</p>
+
+<!-- Caption context -->
+<small data-font-family="ui" data-font-size="xs" data-tracking="wide">
+  Caption
+</small>
+```
+
+## TypeScript Tokens
+
+Typography tokens are available as nested TypeScript objects with `as const` for type safety.
+
+### Import
+
+```typescript
+import { typography } from '@equinor/eds-tokens/ts/typography/font-size-md'
+import { typography } from '@equinor/eds-tokens/ts/typography/font-family-header'
+import { typography } from '@equinor/eds-tokens/ts/typography/font-weight-normal'
+import { typography } from '@equinor/eds-tokens/ts/typography/line-height-default'
+import { typography } from '@equinor/eds-tokens/ts/typography/tracking-tight'
+```
+
+### Available Files
+
+Each mode of each axis has its own file:
+
+| Axis | Files |
+|------|-------|
+| Font family | `font-family-header`, `font-family-ui` |
+| Font size | `font-size-xs`, `font-size-sm`, `font-size-md`, `font-size-lg`, `font-size-xl`, `font-size-2xl`, `font-size-3xl`, `font-size-4xl`, `font-size-5xl`, `font-size-6xl` |
+| Font weight | `font-weight-lighter`, `font-weight-normal`, `font-weight-bolder` |
+| Line height | `line-height-default`, `line-height-squished` |
+| Tracking | `tracking-tight`, `tracking-normal`, `tracking-wide`, `tracking-loose` |
+
+### Usage
+
+```typescript
+import { typography } from '@equinor/eds-tokens/ts/typography/font-size-md'
+
+// Font size files contain resolved values for that size
+typography.typography['font-size']        // '16'
+typography.typography['line-height-default'] // '20'
+typography.typography['font-weight-normal'] // '400'
+```
+
+```typescript
+import { typography } from '@equinor/eds-tokens/ts/typography/font-family-header'
+
+// Font family files contain the family and all size-specific values
+typography.typography['font-family']      // 'Equinor'
+typography['font-family-size'].md['font-size'] // '16'
+```
+
+### Naming Conversion
+
+CSS variable segments map to TypeScript object keys:
+
+| CSS variable | TypeScript path |
+|---|---|
+| `--eds-typography-font-size` | `typography.typography['font-size']` |
+| `--eds-typography-font-weight` | `typography.typography['font-weight']` |
+| `--eds-typography-tracking` | `typography.typography.tracking` |
+
+## Output Formats
+
+| Format | Import path | Use case |
+|--------|-------------|----------|
+| **CSS variables** | `@equinor/eds-tokens/css/variables` | Standard web styling via data attributes |
+| **TypeScript (nested)** | `@equinor/eds-tokens/ts/typography/*` | Type-safe access with autocomplete |
+
+## Best Practices
+
+- **Use data attributes** -- Let the token system resolve the right values rather than hardcoding
+- **Scale together** -- Font size, icon size, and gap are designed to work as a unit
+- **Combine axes freely** -- Each axis is independent; mix and match as needed
+- **Test across sizes** -- Verify layouts work at all font size modes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/eds-tokens",
-  "version": "2.2.0",
+  "version": "2.3.0-beta.0",
   "description": "Design tokens for the Equinor Design System",
   "type": "module",
   "exports": {
@@ -16,7 +16,10 @@
     "./css/variables.css": "./build/css/variables.min.css",
     "./json/*/*": "./build/json/*/*.json",
     "./js/color/*": "./build/js/color/*.js",
-    "./js/spacing/*": "./build/js/spacing/*.js"
+    "./js/spacing/*": "./build/js/spacing/*.js",
+    "./ts/color/*": "./build/ts/color/*.ts",
+    "./ts/spacing/*": "./build/ts/spacing/*.ts",
+    "./ts/typography/*": "./build/ts/typography/*.ts"
   },
   "types": "./dist/types/index.d.ts",
   "main": "./dist/tokens.cjs",
@@ -42,31 +45,6 @@
     "tokens.css",
     "elements.css"
   ],
-  "keywords": [
-    "eds",
-    "design system",
-    "equinor",
-    "design tokens"
-  ],
-  "devDependencies": {
-    "@rollup/plugin-babel": "^6.1.0",
-    "@rollup/plugin-commonjs": "^28.0.8",
-    "@rollup/plugin-node-resolve": "^16.0.3",
-    "@types/node": "^25.2.3",
-    "copyfiles": "^2.4.1",
-    "lightningcss-cli": "^1.31.1",
-    "prettier": "3.8.1",
-    "rimraf": "^6.1.2",
-    "rollup": "^4.57.1",
-    "rollup-plugin-delete": "^3.0.2",
-    "style-dictionary": "^5.3.0",
-    "style-dictionary-utils": "^4.1.0",
-    "typescript": "^5.9.3",
-    "vite": "^7.3.1",
-    "@equinor/eds-color-palette-generator": "^0.1.0",
-    "@equinor/eds-tokens-build": "^1.1.0",
-    "@equinor/eds-tokens-sync": "^1.0.0"
-  },
   "scripts": {
     "build": "rollup -c && pnpm run types",
     "dev": "rollup -c -w",
@@ -102,5 +80,30 @@
     "update-figma:color-dynamic": "sync-tokens-to-figma --file-key nyPaQ3QnI1UAcxKW4a0d2c",
     "update-tokens": "pnpm run update-tokens:foundations && pnpm run update-tokens:color-static && pnpm run update-tokens:color-dynamic && pnpm run update-tokens:spacing-primitives && pnpm run update-tokens:spacing-modes",
     "update-figma": "pnpm run update-figma:foundations && pnpm run update-figma:color-static && pnpm run update-figma:color-dynamic && pnpm run update-figma:spacing-primitives && pnpm run update-figma:spacing-modes"
+  },
+  "keywords": [
+    "eds",
+    "design system",
+    "equinor",
+    "design tokens"
+  ],
+  "devDependencies": {
+    "@equinor/eds-color-palette-generator": "workspace:^",
+    "@equinor/eds-tokens-build": "workspace:^",
+    "@equinor/eds-tokens-sync": "workspace:^",
+    "@rollup/plugin-babel": "^6.1.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@types/node": "^25.3.0",
+    "copyfiles": "^2.4.1",
+    "lightningcss-cli": "^1.31.1",
+    "prettier": "3.8.1",
+    "rimraf": "^6.1.3",
+    "rollup": "^4.59.0",
+    "rollup-plugin-delete": "^3.0.2",
+    "style-dictionary": "^5.3.2",
+    "style-dictionary-utils": "^4.1.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-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.