@rio-m3e/tokens 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,6 @@
+Rio
+Copyright 2026 LegenLee
+
+This product bundles material-color-utilities
+(https://github.com/material-foundation/material-color-utilities),
+Copyright 2021 Google LLC, licensed under the Apache License, Version 2.0.

package/README.md

@@ -1,3 +1,13 @@
-# Temporary Holding Version
+# @rio-m3e/tokens
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Design tokens for [Rio](https://github.com/LegenLee/rio), a Material 3 Expressive implementation: color schemes from a source color, elevation, motion, shape, typography, and states, as `--rio-*` CSS variables.
+
+```ts
+import { applyTheme } from '@rio-m3e/tokens';
+
+applyTheme(document.documentElement, { sourceColor: '#6750a4' });
+```
+
+`createThemeCss` returns the same variables as a stylesheet, for server rendering or a static file.
+
+Licensed under the Apache License 2.0. It bundles [material-color-utilities](https://github.com/material-foundation/material-color-utilities) by Google LLC, also under the Apache License 2.0; see `NOTICE`.

package/dist/index.d.ts

@@ -0,0 +1,184 @@
+export declare const TOKEN_PREFIX = "--rio";
+/** M3 color roles. The names match the method names on MCU's `MaterialDynamicColors`. */
+export declare const COLOR_ROLES: readonly ["background", "onBackground", "surface", "surfaceDim", "surfaceBright", "surfaceContainerLowest", "surfaceContainerLow", "surfaceContainer", "surfaceContainerHigh", "surfaceContainerHighest", "onSurface", "surfaceVariant", "onSurfaceVariant", "inverseSurface", "inverseOnSurface", "outline", "outlineVariant", "shadow", "scrim", "surfaceTint", "primary", "primaryDim", "onPrimary", "primaryContainer", "onPrimaryContainer", "primaryFixed", "primaryFixedDim", "onPrimaryFixed", "onPrimaryFixedVariant", "inversePrimary", "secondary", "secondaryDim", "onSecondary", "secondaryContainer", "onSecondaryContainer", "secondaryFixed", "secondaryFixedDim", "onSecondaryFixed", "onSecondaryFixedVariant", "tertiary", "tertiaryDim", "onTertiary", "tertiaryContainer", "onTertiaryContainer", "tertiaryFixed", "tertiaryFixedDim", "onTertiaryFixed", "onTertiaryFixedVariant", "error", "errorDim", "onError", "errorContainer", "onErrorContainer"];
+type ColorRole = (typeof COLOR_ROLES)[number];
+type ColorVar = `${typeof TOKEN_PREFIX}-color-${string}`;
+/** CSS variable name for a role. `onPrimaryContainer` → `--rio-color-on-primary-container` */
+export declare function colorVar(role: ColorRole): ColorVar;
+/** Colors by role, as `#rrggbb`. */
+type ColorScheme = Record<ColorRole, string>;
+/**
+ * Only the variants that support M3E (the 2025 color spec) are exposed.
+ * For the others (monochrome, fidelity, and so on), MCU silently falls back to the 2021 spec.
+ */
+type SchemeVariant = 'tonal-spot' | 'neutral' | 'vibrant' | 'expressive';
+interface ColorSchemeOptions {
+  /** Source color, as `#rgb` or `#rrggbb`. */
+  sourceColor: string;
+  /** Defaults to `'tonal-spot'`. */
+  variant?: SchemeVariant;
+  /** From -1 (reduced) through 0 (standard) to 1 (high). Defaults to 0. */
+  contrast?: number;
+  /** Defaults to `false`. */
+  dark?: boolean;
+}
+export declare function createColorScheme(options: ColorSchemeOptions): ColorScheme;
+export declare const ELEVATION_LEVELS: readonly [0, 1, 2, 3, 4, 5];
+/** 0–3 are resting states. 4–5 are for interaction states only, such as hover and drag. */
+type ElevationLevel = (typeof ELEVATION_LEVELS)[number];
+type ElevationVar = `${typeof TOKEN_PREFIX}-elevation-level${ElevationLevel}`;
+/** CSS variable name for a level. `3` → `--rio-elevation-level3` */
+export declare function elevationVar(level: ElevationLevel): ElevationVar;
+/** `box-shadow` values by level. The shadow color follows the theme's shadow role. */
+export declare function createElevationVariables(): Record<ElevationVar, string>;
+export declare const MOTION_SCHEMES: readonly ["expressive", "standard"];
+/** `expressive` is the M3E default. `standard` is for utilitarian products. */
+type MotionScheme = (typeof MOTION_SCHEMES)[number];
+export declare const MOTION_TOKENS: readonly ["fast-spatial", "default-spatial", "slow-spatial", "fast-effects", "default-effects", "slow-effects"];
+/**
+ * Spatial tokens move things (position, size, rotation, corner radius) and may overshoot.
+ * Effects tokens change color and opacity and never overshoot.
+ */
+type MotionToken = (typeof MOTION_TOKENS)[number];
+/**
+ * The spatial tokens. Their springs are also available in the standard scheme whatever the
+ * theme's scheme, for motion the spec pins to it, such as the split button's menu icon.
+ */
+export declare const SPATIAL_MOTION_TOKENS: readonly ["fast-spatial", "default-spatial", "slow-spatial"];
+type SpatialMotionToken = (typeof SPATIAL_MOTION_TOKENS)[number];
+interface MotionSpring {
+  /** 1 settles without overshoot; lower values bounce. */
+  dampingRatio: number;
+  stiffness: number;
+}
+interface MotionCurve {
+  /** A CSS `cubic-bezier()` that mimics the spring. */
+  easing: string;
+  /** In milliseconds. */
+  duration: number;
+}
+/** Raw spring values, for animations that can be interrupted or driven by gestures. */
+export declare function getMotionSpring(scheme: MotionScheme, token: MotionToken): MotionSpring;
+/** The curve that mimics a spring, for animations that are never interrupted. */
+export declare function getMotionCurve(scheme: MotionScheme, token: MotionToken): MotionCurve;
+/** `duration` and `easing` describe the curve; `damping` and `stiffness` the raw spring. */
+type MotionVarPart = 'duration' | 'easing' | 'damping' | 'stiffness';
+type MotionVar = `${typeof TOKEN_PREFIX}-motion-${MotionToken}` | `${typeof TOKEN_PREFIX}-motion-${MotionToken}-${MotionVarPart}` | StandardSpringVar;
+type StandardSpringVar = `${typeof TOKEN_PREFIX}-motion-standard-${SpatialMotionToken}-${'damping' | 'stiffness'}`;
+/**
+ * CSS variable for a spatial token's spring in the standard scheme, set whatever the theme's
+ * scheme is. In `@rio-m3e/core`, `readSpringParams(element, 'standard-fast-spatial')` reads it.
+ */
+export declare function standardSpringVar(token: SpatialMotionToken, part: 'damping' | 'stiffness'): StandardSpringVar;
+/**
+ * CSS variable name for a token. Without `part`, the variable holds `<duration> <easing>`
+ * and fits straight into `transition` or `animation`:
+ * `transition: transform var(--rio-motion-fast-spatial)`.
+ */
+export declare function motionVar(token: MotionToken, part?: MotionVarPart): MotionVar;
+/**
+ * CSS variables for one scheme: the curve for CSS transitions, and the raw spring for the spring
+ * solver in `@rio-m3e/core`, which reads them from the element it animates. The names don't
+ * include the scheme. The standard scheme's spatial springs are added under their own names
+ * (`standardSpringVar`) whatever the scheme.
+ */
+export declare function createMotionVariables(scheme?: MotionScheme): Record<MotionVar, string>;
+export declare const SHAPE_CORNERS: readonly ["none", "extra-small", "small", "medium", "large", "large-increased", "extra-large", "extra-large-increased", "extra-extra-large", "full"];
+/** The M3 corner radius scale. The `*-increased` and `extra-extra-large` steps are new in M3E. */
+type ShapeCorner = (typeof SHAPE_CORNERS)[number];
+/** The steps a theme may resize. `none` and `full` are fixed, as in Compose's `Shapes`. */
+type CustomizableShapeCorner = Exclude<ShapeCorner, 'none' | 'full'>;
+/** Radii in px, overriding the defaults: `{ medium: 16 }`. */
+type ShapeOverrides = Partial<Record<CustomizableShapeCorner, number>>;
+type ShapeVar = `${typeof TOKEN_PREFIX}-shape-corner-${ShapeCorner}`;
+/** CSS variable name for a corner. `medium` → `--rio-shape-corner-medium` */
+export declare function shapeVar(corner: ShapeCorner): ShapeVar;
+/**
+ * Corner radius variables. Asymmetric shapes (the spec's top, start, and end tokens) need no extra
+ * variables: set the individual corners with logical properties such as `border-start-start-radius`.
+ */
+export declare function createShapeVariables(overrides?: ShapeOverrides): Record<ShapeVar, string>;
+export declare const STATE_LAYER_STATES: readonly ["hover", "focus", "pressed", "dragged", "disabled"];
+/**
+ * States with a state-layer opacity token. `disabled` is named like the others, but components
+ * apply it to disabled labels and icons rather than to an overlay.
+ */
+type StateLayerState = (typeof STATE_LAYER_STATES)[number];
+export declare const FOCUS_INDICATOR_PARTS: readonly ["thickness", "outer-offset", "inner-offset"];
+type FocusIndicatorPart = (typeof FOCUS_INDICATOR_PARTS)[number];
+type StateVar = `${typeof TOKEN_PREFIX}-state-${StateLayerState}-state-layer-opacity` | `${typeof TOKEN_PREFIX}-state-focus-indicator-${FocusIndicatorPart}`;
+/** CSS variable name for a state-layer opacity. `hover` → `--rio-state-hover-state-layer-opacity` */
+export declare function stateLayerOpacityVar(state: StateLayerState): StateVar;
+/** CSS variable name for the focus indicator. `thickness` → `--rio-state-focus-indicator-thickness` */
+export declare function focusIndicatorVar(part: FocusIndicatorPart): StateVar;
+/** State-layer opacities and focus indicator dimensions. Fixed values. */
+export declare function createStateVariables(): Record<StateVar, string>;
+export declare const TYPE_STYLES: readonly ["display-large", "display-medium", "display-small", "headline-large", "headline-medium", "headline-small", "title-large", "title-medium", "title-small", "body-large", "body-medium", "body-small", "label-large", "label-medium", "label-small"];
+type TypeStyle = (typeof TYPE_STYLES)[number];
+/** `brand` sets the larger styles (display, headline, title large); `plain` sets the rest. */
+type Typeface = 'brand' | 'plain';
+/** Font-family values for the two typefaces. */
+type TypefaceOverrides = Partial<Record<Typeface, string>>;
+interface TypeStyleSpec {
+  typeface: Typeface;
+  /** In px. */
+  size: number;
+  /** In px. */
+  lineHeight: number;
+  /** Letter spacing, in px. */
+  tracking: number;
+  weight: number;
+}
+interface TypeStyleOptions {
+  /** The M3E emphasized set: heavier, for selection, actions, and editorial emphasis. */
+  emphasized?: boolean;
+}
+type TypescalePart = 'font' | 'size' | 'line-height' | 'weight' | 'tracking';
+type TypefaceVar = `${typeof TOKEN_PREFIX}-typeface-${Typeface}`;
+type TypescaleVar = `${typeof TOKEN_PREFIX}-typescale-${'' | 'emphasized-'}${TypeStyle}` | `${typeof TOKEN_PREFIX}-typescale-${'' | 'emphasized-'}${TypeStyle}-${TypescalePart}`;
+type TypographyVar = TypefaceVar | TypescaleVar;
+/** The values behind a style, in px. */
+export declare function getTypeStyle(style: TypeStyle, options?: TypeStyleOptions): TypeStyleSpec;
+/** CSS variable name for a typeface. `brand` → `--rio-typeface-brand` */
+export declare function typefaceVar(typeface: Typeface): TypefaceVar;
+/**
+ * CSS variable name for a style. Without `part`, the variable holds a `font` shorthand
+ * (`font: var(--rio-typescale-label-large)`). Letter spacing isn't part of `font`, so set it with
+ * the `tracking` part.
+ */
+export declare function typescaleVar(style: TypeStyle, options?: TypeStyleOptions & {
+  part?: TypescalePart;
+}): TypescaleVar;
+/** Typeface and type scale variables for both the baseline and emphasized sets. */
+export declare function createTypographyVariables(typefaces?: TypefaceOverrides): Record<TypographyVar, string>;
+interface ThemeOptions extends Omit<ColorSchemeOptions, 'dark'> {
+  /** Defaults to `'expressive'`. */
+  motion?: MotionScheme;
+  /** Resizes steps of the corner radius scale, in px: `{ medium: 16 }`. */
+  shapes?: ShapeOverrides;
+  /** Font-family values: `{ brand: '"Roboto Flex", sans-serif' }`. Both default to Roboto. */
+  typefaces?: TypefaceOverrides;
+}
+type ThemeVar = ColorVar | ElevationVar | MotionVar | ShapeVar | StateVar | TypographyVar;
+/**
+ * Every CSS variable in the theme.
+ * - Colors: light and dark values are combined with `light-dark()`. Which one applies depends on the
+ *   `color-scheme` of the element that uses the variable.
+ * - Elevation: fixed values that don't depend on the options.
+ * - Motion: curves for the chosen scheme. The variable names are the same for every scheme, so a
+ *   subtree can switch schemes by overriding them.
+ * - Shape: the corner radius scale, with any overrides applied.
+ * - Typography: the baseline and emphasized type scales, in rem, on top of two typefaces.
+ * - State: state-layer opacities and focus indicator dimensions. Fixed values.
+ */
+export declare function createThemeVariables(options: ThemeOptions): Record<ThemeVar, string>;
+/** A CSS string for SSR or static stylesheets. Includes `color-scheme: light dark`. */
+export declare function createThemeCss(options: ThemeOptions & {
+  selector?: string;
+}): string;
+/**
+ * Sets the theme variables as inline styles on an element.
+ * It doesn't touch `color-scheme`; set that yourself.
+ */
+export declare function applyTheme(target: HTMLElement, options: ThemeOptions): void;
+export type { ColorRole, ColorScheme, ColorSchemeOptions, ColorVar, CustomizableShapeCorner, ElevationLevel, ElevationVar, FocusIndicatorPart, MotionCurve, MotionScheme, MotionSpring, MotionToken, MotionVar, MotionVarPart, SchemeVariant, ShapeCorner, ShapeOverrides, ShapeVar, SpatialMotionToken, StandardSpringVar, StateLayerState, StateVar, ThemeOptions, ThemeVar, TypeStyle, TypeStyleOptions, TypeStyleSpec, Typeface, TypefaceOverrides, TypefaceVar, TypescalePart, TypescaleVar, TypographyVar };