Files
supabase/apps/studio/lib/theme-overrides.ts
T
cc540ff302 feat(studio): add safe theme colour controls (#49804)
## What kind of change does this PR introduce?

Feature.

## What is the current behaviour?

Studio Appearance preferences only select a theme mode. The underlying
theme colours cannot be adjusted, and the existing proof of concept
allowed unsafe combinations and introduced a bespoke Slider variant.

## What is the new behaviour?

- Preserves the existing System, Dark, Light, and Classic Dark theme
options. Classic Dark remains a fixed preset.
- Adds four theme colour controls using the existing Supabase Slider
unchanged. Each control presents a consistent 0 to 100 scale mapped to
bounded light and dark ranges.
- Previews colour changes while dragging and persists them once the
interaction finishes, including rapid pointer gestures.
- Stores light and dark overrides separately, validates stored values,
clamps legacy values, and removes overrides that return to their shipped
defaults.
- Adds concise descriptions for Chroma, Contrast, Surface, and Elevation
step, with a scoped Reset action shown only when the active theme
differs from its defaults.
- Keeps Slider in a stable shared chunk so production builds do not
create a circular dependency between generated UI chunks.

| Before | After |
| --- | --- |
| <img width="1448" height="1284" alt="CleanShot 2026-09-15 at 14 33
53@2x"
src="https://github.com/user-attachments/assets/d55151c7-b2a9-40c6-9468-e77ae685ac38"
/> | <img width="1454" height="1958" alt="CleanShot 2026-09-15 at 17 48
47@2x"
src="https://github.com/user-attachments/assets/9d302e67-76cc-4341-948c-81713dea2e93"
/> |

## To test

1. Open `/account/me` and scroll to Appearance.
2. Switch between System, Dark, Light, and Classic Dark. Confirm the
same four modes remain available in the account theme menu.
3. Confirm Classic Dark retains its existing appearance and does not
show theme colour controls.
4. In System, Dark, or Light, move each Theme colors slider to both
ends. Confirm the dashboard previews the change, remains readable, and
the theme cards do not shift or remount.
5. Reload the page and confirm colour changes persist separately for
Light and Dark.
6. Return all sliders to their defaults, or select Reset, and confirm
the Reset action disappears.
7. In System mode, change the operating system theme and confirm each
resolved mode restores its own colour settings.

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
2026-09-17 10:33:59 +10:00

217 lines
6.4 KiB
TypeScript

import * as z from 'zod'
export type ThemeOverrideKey = 'chroma' | 'contrast' | 'surface' | 'elevationStep'
export type ThemeOverrideMode = 'dark' | 'light'
type ThemeOverrideRange = { min: number; max: number }
export interface ThemeOverrideKnob {
key: ThemeOverrideKey
cssVar: string
label: string
description: string
ranges: Record<ThemeOverrideMode, ThemeOverrideRange>
}
export const THEME_OVERRIDE_KNOBS: readonly ThemeOverrideKnob[] = [
{
key: 'chroma',
cssVar: '--chroma',
label: 'Color intensity',
description: 'Controls how vivid interface colors appear.',
ranges: { dark: { min: 0, max: 0.04 }, light: { min: 0, max: 0.03 } },
},
{
key: 'contrast',
cssVar: '--contrast',
label: 'Contrast',
description: 'Controls the difference between text, borders, and backgrounds.',
ranges: { dark: { min: 0.4, max: 0.8 }, light: { min: 0.45, max: 0.8 } },
},
{
key: 'surface',
cssVar: '--surface',
label: 'Surface brightness',
description: 'Controls how light or dark background surfaces appear.',
ranges: { dark: { min: 0.12, max: 0.32 }, light: { min: 0.82, max: 0.995 } },
},
{
key: 'elevationStep',
cssVar: '--elevation-step',
label: 'Layer contrast',
description: 'Controls the difference between stacked surfaces.',
ranges: { dark: { min: 0, max: 0.24 }, light: { min: 0, max: 0.024 } },
},
]
export const THEME_OVERRIDE_DEFAULTS: Record<
ThemeOverrideMode,
Record<ThemeOverrideKey, number>
> = {
dark: { chroma: 0.005, contrast: 0.5, surface: 0.19, elevationStep: 0.025 },
light: { chroma: 0, contrast: 0.53, surface: 0.995, elevationStep: 0.024 },
}
export type ThemeOverrides = Partial<Record<ThemeOverrideKey, number>>
export type ThemeOverridesByMode = Partial<Record<ThemeOverrideMode, ThemeOverrides>>
const themeOverridesSchema = z
.object({
chroma: z.number().finite().optional(),
contrast: z.number().finite().optional(),
surface: z.number().finite().optional(),
elevationStep: z.number().finite().optional(),
})
.strip()
const themeOverridesByModeSchema = z
.object({ dark: themeOverridesSchema.optional(), light: themeOverridesSchema.optional() })
.strip()
export function resolveThemeOverrideMode(resolvedTheme: string | undefined): ThemeOverrideMode {
return resolvedTheme?.includes('dark') ? 'dark' : 'light'
}
export function getThemeOverrideRange(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode
): ThemeOverrideRange {
return knob.ranges[mode]
}
export function clampThemeOverride(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode,
value: number
): number {
const { min, max } = getThemeOverrideRange(knob, mode)
return Math.min(max, Math.max(min, value))
}
export function themeOverrideToSliderValue(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode,
value: number
): number {
const { min, max } = getThemeOverrideRange(knob, mode)
const clamped = clampThemeOverride(knob, mode, value)
return Math.round(((clamped - min) / (max - min)) * 100)
}
export function sliderValueToThemeOverride(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode,
value: number
): number {
const { min, max } = getThemeOverrideRange(knob, mode)
const clamped = Math.min(100, Math.max(0, value))
return Number((min + (max - min) * (clamped / 100)).toFixed(6))
}
export function getThemeOverrideValue(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode,
overrides: ThemeOverrides
): number {
const value = overrides[knob.key] ?? THEME_OVERRIDE_DEFAULTS[mode][knob.key]
return clampThemeOverride(knob, mode, value)
}
function isDefaultValue(knob: ThemeOverrideKnob, mode: ThemeOverrideMode, value: number): boolean {
const defaultValue = THEME_OVERRIDE_DEFAULTS[mode][knob.key]
return (
themeOverrideToSliderValue(knob, mode, value) ===
themeOverrideToSliderValue(knob, mode, defaultValue)
)
}
export function mergeThemeOverride(
current: ThemeOverridesByMode,
mode: ThemeOverrideMode,
key: ThemeOverrideKey,
value: number
): ThemeOverridesByMode {
const knob = THEME_OVERRIDE_KNOBS.find((candidate) => candidate.key === key)
if (knob === undefined) return current
const nextMode = { ...current[mode] }
const clamped = clampThemeOverride(knob, mode, value)
if (isDefaultValue(knob, mode, clamped)) delete nextMode[key]
else nextMode[key] = clamped
if (!hasThemeOverrides(nextMode)) return clearThemeOverridesForMode(current, mode)
return { ...current, [mode]: nextMode }
}
export function clearThemeOverridesForMode(
current: ThemeOverridesByMode,
mode: ThemeOverrideMode
): ThemeOverridesByMode {
const { [mode]: _removed, ...rest } = current
return rest
}
export function hasThemeOverrides(overrides: ThemeOverrides): boolean {
return THEME_OVERRIDE_KNOBS.some((knob) => overrides[knob.key] !== undefined)
}
function sanitizeThemeOverrides(
mode: ThemeOverrideMode,
overrides: ThemeOverrides
): ThemeOverrides {
return THEME_OVERRIDE_KNOBS.reduce<ThemeOverrides>((result, knob) => {
const value = overrides[knob.key]
if (value === undefined) return result
const clamped = clampThemeOverride(knob, mode, value)
if (!isDefaultValue(knob, mode, clamped)) result[knob.key] = clamped
return result
}, {})
}
export function parseThemeOverridesByMode(value: unknown): ThemeOverridesByMode {
const parsed = themeOverridesByModeSchema.safeParse(value)
if (!parsed.success) return {}
const dark = sanitizeThemeOverrides('dark', parsed.data.dark ?? {})
const light = sanitizeThemeOverrides('light', parsed.data.light ?? {})
return {
...(hasThemeOverrides(dark) ? { dark } : {}),
...(hasThemeOverrides(light) ? { light } : {}),
}
}
export function applyThemeOverrides(
root: HTMLElement,
mode: ThemeOverrideMode,
overrides: ThemeOverrides
) {
THEME_OVERRIDE_KNOBS.forEach((knob) => {
const value = overrides[knob.key]
if (value === undefined) root.style.removeProperty(knob.cssVar)
else root.style.setProperty(knob.cssVar, String(clampThemeOverride(knob, mode, value)))
})
}
export function applyResolvedThemeOverrides(
root: HTMLElement,
resolvedTheme: string | undefined,
mode: ThemeOverrideMode,
overrides: ThemeOverrides
) {
applyThemeOverrides(root, mode, resolvedTheme === 'classic-dark' ? {} : overrides)
}
export function previewThemeOverride(
knob: ThemeOverrideKnob,
mode: ThemeOverrideMode,
value: number
) {
document.documentElement.style.setProperty(
knob.cssVar,
String(clampThemeOverride(knob, mode, value))
)
}