Files
gerbeur/src/contexts/theme/ThemeContext.ts
khannurien f3f07ed1e3
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 49s
Build and Deploy Static Documentation Site / build-and-push (push) Successful in 22s
v3: every doc opens with the role, then the mechanism, then the details — the docs were written bottom-up: what a thing does first ("Declares the three contexts WSProvider fills…"), details that only make sense once its purpose is known next, and the reason it exists last ("…so that a feed doesn't re-render"), so a reader had nothing to hang the first sentences on. The README's rule caused it, since a module doc "opened with what the module does"; it now opens with the module's role in the app, and the value-side phrasing of a type ("Returned to Y by X") comes once the role is said, with WSContext as the before and after. WSContext.ts is rewritten that way throughout, and so are the docs elsewhere that buried their purpose in a trailing "so that" (the migrations, og, image-proxy, public-address, useFading, useFeedCache, the drafts), opened on a generic verb that hid it ("Holds", "Declares", "Loads", "Defines", "Types": the contexts and providers, the shared types, the models, the hooks), or were label fragments ("The page of a dump…", "A row of tabs."). A function whose verb is its action ("Stores session"), a props or result type, and a protocol message ("Sent by X when Y") already say their role and are left as they are. Only comments changed, and the catalogs only move their references; deno fmt, deno lint and doc:lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 21:42:08 +00:00

51 lines
1.4 KiB
TypeScript

/**
* Shares the chosen theme with every component. `ThemeProvider` fills this
* context and `useTheme` reads it.
*
* @module
*/
import { createContext } from "react";
/**
* Lists every site style, which `ThemeProvider` checks a stored choice
* against. Each has a stylesheet under `src/themes/`, keyed on the root
* element's `data-style`, which is absent for "smooth".
*/
export const STYLE_NAMES = [
"smooth",
"brutalist",
"geocities",
"nyt",
"kanagawa",
"melange",
] as const;
/** Held by `ThemeProvider` for the style chosen in this browser. */
export type StyleName = typeof STYLE_NAMES[number];
/** Lists every color scheme. "auto" follows the system's. */
export const COLOR_SCHEMES = ["auto", "light", "dark"] as const;
/** Held by `ThemeProvider` for the color scheme chosen in this browser. */
export type ColorScheme = typeof COLOR_SCHEMES[number];
/**
* Provided by `ThemeProvider` to `useTheme`. A setter applies and stores the
* choice for this browser.
*/
export interface ThemeContextValue {
style: StyleName;
colorScheme: ColorScheme;
setStyle(s: StyleName): void;
setColorScheme(c: ColorScheme): void;
}
/** The theme's context. Its default is only seen outside `ThemeProvider`. */
export const ThemeContext: React.Context<ThemeContextValue> = createContext<
ThemeContextValue
>({
style: "smooth",
colorScheme: "auto",
setStyle: () => {},
setColorScheme: () => {},
});