An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
'use client';
/**
* @file SyntaxTheme.tsx
* @input SyntaxTheme from defineSyntaxTheme.ts
* @output SyntaxTheme provider, useSyntaxTheme hook
* @position Provider component; wraps code surfaces to apply syntax coloring
*
* @see https://github.com/meta/astryx/issues/1148
*/
import React, {use, useMemo} from 'react';
import {
syntaxThemeStyle,
resolveSyntaxTokenForMode,
ALL_SYNTAX_KEYS,
type SyntaxThemeDefinition,
type SyntaxThemeTokenKey,
} from './defineSyntaxTheme';
import {useMediaQuery} from '../../hooks/useMediaQuery';
import {useTheme} from '../useTheme';
import {formatColor, parseColor} from '../../utils/color';
import {createSharedContext} from '../../utils/sharedContext';
// =============================================================================
// Context
// =============================================================================
/** @internal */
interface SyntaxThemeContextValue {
theme: SyntaxThemeDefinition;
}
const SyntaxThemeContext = createSharedContext<SyntaxThemeContextValue | null>(
'SyntaxThemeContext',
1,
null,
);
SyntaxThemeContext.displayName = 'SyntaxThemeContext';
// =============================================================================
// Return type
// =============================================================================
export interface UseSyntaxThemeReturn {
/** Syntax theme name */
name: string;
/** Resolved effective mode ('light' | 'dark') */
mode: 'light' | 'dark';
/**
* Resolve a syntax token to its raw CSS value for the current color mode.
*
* @example
* const keywordColor = token('keyword'); // "#0064E0" in light mode
*/
token: (name: SyntaxThemeTokenKey) => string;
/**
* All syntax tokens resolved for the current color mode.
*/
tokens: Record<SyntaxThemeTokenKey, string>;
}
// =============================================================================
// Hook
// =============================================================================
/** The strength of the default diff row paints: the muted tokens at 25%. */
const DIFF_TINT_STRENGTH = 0.25;
/**
* The colour `color-mix(in srgb, <colour> <strength>, transparent)` paints, as
* a value a canvas can use. Returns undefined for a colour the shared parser
* does not read (the CSS default then stands).
*/
function mixWithTransparent(
colour: string,
strength: number,
): string | undefined {
const parsed = parseColor(colour);
return parsed ? formatColor({...parsed, a: parsed.a * strength}) : undefined;
}
/**
* Access the current syntax theme's token values, resolved for the active
* color mode. Returns null if no SyntaxTheme provider is present.
*
* @example
* function CodeCanvas() {
* const syntax = useSyntaxTheme();
* if (!syntax) {
* return null;
* }
* ctx.fillStyle = syntax.token('keyword');
* }
*/
export function useSyntaxTheme(): UseSyntaxThemeReturn | null {
const ctx = use(SyntaxThemeContext);
const page = useTheme();
const prefersDark = useMediaQuery('(prefers-color-scheme: dark)');
const effectiveMode: 'light' | 'dark' = prefersDark ? 'dark' : 'light';
const tokens = useMemo(() => {
if (!ctx) {
return null;
}
const resolved: Partial<Record<SyntaxThemeTokenKey, string>> = {};
for (const key of ALL_SYNTAX_KEYS) {
const input = ctx.theme.__inputTokens[key];
if (input !== undefined) {
resolved[key] = resolveSyntaxTokenForMode(input, effectiveMode);
}
}
// A diff row slot the theme did not set follows its CSS default; a canvas
// consumer needs a colour it can paint, so the marker slots take the
// theme's own resolved punctuation colour and the row paints derive from
// the enclosing page theme's resolved tokens (the same mix the CSS
// default makes), never from a probe outside the nearest Theme.
for (const key of ALL_SYNTAX_KEYS) {
if (resolved[key] !== undefined) {
continue;
}
const fallback = ctx.theme.tokens[key] ?? '';
if (key === 'added-marker' || key === 'removed-marker') {
resolved[key] = resolved.punctuation ?? fallback;
} else if (key === 'added' || key === 'removed') {
const base = page.token(
key === 'added' ? '--color-success-muted' : '--color-error-muted',
);
resolved[key] =
mixWithTransparent(base, DIFF_TINT_STRENGTH) ?? fallback;
} else {
resolved[key] = fallback;
}
}
return resolved as Record<SyntaxThemeTokenKey, string>;
}, [ctx, effectiveMode, page]);
if (!ctx || !tokens) {
return null;
}
return {
name: ctx.theme.name,
mode: effectiveMode,
token: (name: SyntaxThemeTokenKey) => tokens[name] ?? '',
tokens,
};
}
// =============================================================================
// Component
// =============================================================================
interface SyntaxThemeProps {
theme: SyntaxThemeDefinition;
children: React.ReactNode;
}
/**
* Syntax theme provider. Sets CSS custom properties on a wrapper div
* so child code components inherit via cascade.
*/
export function SyntaxTheme({
theme,
children,
}: SyntaxThemeProps): React.ReactElement {
const style = useMemo(() => syntaxThemeStyle(theme), [theme]);
const value = useMemo(() => ({theme}), [theme]);
return (
<SyntaxThemeContext value={value}>
<div style={style} data-astryx-syntax-theme={theme.name}>
{children}
</div>
</SyntaxThemeContext>
);
}
SyntaxTheme.displayName = 'SyntaxTheme';