docs/vet/mcp/modules/shared-theme.themePrimitives.json

{
  "module": "shared-theme.themePrimitives",
  "content": {
    "path": "shared-theme.themePrimitives",
    "docstring": "Base design tokens and palettes for the Veterinary Clinic theme.\r\n\r\nDefines the raw color ramps (`brand`, `gray`, `green`, `orange`, `red`), the\r\nlight/dark design tokens (`getDesignTokens`), and the `colorSchemes`,\r\n`typography`, `shape` and `shadows` primitives. Also augments MUI's theme\r\ntypes with the `ColorRange`, `flows` and `baseShadow` extensions.",
    "objects": {
      "brand": {
        "name": "brand",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.brand",
        "signature": "brand: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }",
        "docstring": "Brand blue color ramp (50-900)."
      },
      "colorSchemes": {
        "name": "colorSchemes",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.colorSchemes",
        "signature": "colorSchemes: { dark: { palette: { action: { hover: string; selected: string }; background: { default: string; paper: string }; baseShadow: string; divider: string; error: { dark: string; light: string; main: string }; flows: { inflows: { primary: string; surface: string; text: string }; outflows: { primary: string; surface: string; text: string } }; grey: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 750: string; 800: string; 850: string; 900: string }; info: { contrastText: string; dark: string; light: string; main: string }; primary: { contrastText: string; dark: string; light: string; main: string }; success: { dark: string; light: string; main: string }; text: { primary: string; secondary: string }; warning: { dark: string; light: string; main: string } } }; light: { palette: { action: { hover: string; selected: string }; background: { default: string; paper: string }; baseShadow: string; divider: string; error: { dark: string; light: string; main: string }; flows: { inflows: { primary: string; surface: string; text: string }; outflows: { primary: string; surface: string; text: string } }; grey: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 750: string; 800: string; 850: string; 900: string }; info: { contrastText: string; dark: string; light: string; main: string }; primary: { contrastText: string; dark: string; light: string; main: string }; success: { dark: string; light: string; main: string }; text: { primary: string; secondary: string; warning: string }; warning: { dark: string; light: string; main: string } } } }",
        "docstring": "Explicit light/dark `colorSchemes` palette definitions."
      },
      "gray": {
        "name": "gray",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.gray",
        "signature": "gray: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 750: string; 800: string; 850: string; 900: string }",
        "docstring": "Neutral gray color ramp (50-900, plus 750/850)."
      },
      "green": {
        "name": "green",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.green",
        "signature": "green: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }",
        "docstring": "Green (success) color ramp (50-900)."
      },
      "orange": {
        "name": "orange",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.orange",
        "signature": "orange: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }",
        "docstring": "Orange (warning) color ramp (50-900)."
      },
      "red": {
        "name": "red",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.red",
        "signature": "red: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 800: string; 900: string }",
        "docstring": "Red (error) color ramp (50-900)."
      },
      "shadows": {
        "name": "shadows",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.shadows",
        "signature": "shadows: Shadows",
        "docstring": "Shadow scale (index 0 `none`, index 1 the template `baseShadow`)."
      },
      "shape": {
        "name": "shape",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.shape",
        "signature": "shape: { borderRadius: number }",
        "docstring": "Shape tokens (global border radius)."
      },
      "typography": {
        "name": "typography",
        "kind": "variable",
        "path": "shared-theme.themePrimitives.typography",
        "signature": "typography: { body1: { fontSize: string }; body2: { fontSize: string; fontWeight: number }; caption: { fontSize: string; fontWeight: number }; fontFamily: string; h1: { fontSize: string; fontWeight: number; letterSpacing: number; lineHeight: number }; h2: { fontSize: string; fontWeight: number; lineHeight: number }; h3: { fontSize: string; lineHeight: number }; h4: { fontSize: string; fontWeight: number; lineHeight: number }; h5: { fontSize: string; fontWeight: number }; h6: { fontSize: string; fontWeight: number }; subtitle1: { fontSize: string }; subtitle2: { fontSize: string; fontWeight: number } }",
        "docstring": "Typography scale (Inter) used by the theme."
      },
      "getDesignTokens": {
        "name": "getDesignTokens",
        "kind": "function",
        "path": "shared-theme.themePrimitives.getDesignTokens",
        "signature": "getDesignTokens(mode: PaletteMode): { palette: { action: { hover: string; selected: string }; background: { default: string; paper: string }; divider: string; error: { dark: string; light: string; main: string }; flows: { inflows: { primary: string; surface: string; text: string }; outflows: { primary: string; surface: string; text: string } }; grey: { 100: string; 200: string; 300: string; 400: string; 50: string; 500: string; 600: string; 700: string; 750: string; 800: string; 850: string; 900: string }; info: { contrastText: string; dark: string; light: string; main: string }; mode: PaletteMode; primary: { contrastText: string; dark: string; light: string; main: string }; success: { dark: string; light: string; main: string }; text: { primary: string; secondary: string; warning: string }; warning: { dark: string; light: string; main: string } }; shadows: Shadows; shape: { borderRadius: number }; typography: { body1: { fontSize: string }; body2: { fontSize: string; fontWeight: number }; caption: { fontSize: string; fontWeight: number }; fontFamily: string; h1: { fontSize: string; fontWeight: number; letterSpacing: number; lineHeight: number }; h2: { fontSize: string; fontWeight: number; lineHeight: number }; h3: { fontSize: string; lineHeight: number }; h4: { fontSize: string; fontWeight: number; lineHeight: number }; h5: { fontSize: string; fontWeight: number }; h6: { fontSize: string; fontWeight: number }; subtitle1: { fontSize: string }; subtitle2: { fontSize: string; fontWeight: number } } }",
        "docstring": "Build the MUI design tokens (palette, typography, shape, shadows) for a mode.\r\n\r\nLight and dark palettes share the ramps but override specific slots in dark\r\nmode. Also sets `shadows[1]` (the \"baseShadow\") per mode. The returned object\r\nis spread into `createTheme` by `AppTheme`.\n\n**Parameters:**\n\n- `mode` — `\"light\"` or `\"dark\"`.\n\n**Returns:**\n\nA MUI `ThemeOptions`-shaped object (palette, typography, shape,\r\nshadows)."
      }
    }
  }
}