mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-17 05:20:55 +00:00
🎨 fix: Draw Library Colours From Theme Roles and Record the Exceptions (#16482)
* fix: Draw Library Colours From Theme Roles and Record the Exceptions PixelCard resolves its variant palettes from theme channel variables when it lays out pixels, so the image generation placeholder follows the active theme in dark mode instead of drawing a fixed light slate palette. The SAML glyph and Codey mark take the text colour. The new theme/allowlist.md records every colour that deliberately sits outside the theme (brand marks, artwork, theme definitions, library elevation ink) and why. * fix: Repaint the Pixel Card When the Theme Changes The palette is read from theme variables when the pixels are laid out, so a mode switch or an applied theme left the previous theme's pixels on the canvas. The card now lays its pixels out again when the root's class or inline variables change. * fix: Keep the Pixel Card's Decorative Presets as Given The blue, yellow and pink presets have no theme role that reproduces them, so they keep their original palettes and are recorded in the allowlist; only the default palette, the one the app renders, reads theme roles. * test: Cover the SAML Glyph Following the Button Text Colour * fix: Lay the Pixel Card Out Again Only When Its Palette Changes The root's inline style also carries unrelated variables such as the scrollbar gutter and markdown font size, and relaying the pixels on every write blinked and replayed an in-progress card. The allowlist now states what it covers and where the skipped files are tracked. * test: Key the Pixel Card Palette Mock by Variable Name
This commit is contained in:
parent
2d7133fcb1
commit
f546dc2bee
7 changed files with 235 additions and 11 deletions
44
e2e/specs/mock/scenarios/saml-glyph.spec.ts
Normal file
44
e2e/specs/mock/scenarios/saml-glyph.spec.ts
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
import { expect, test } from '@playwright/test';
|
||||
|
||||
/**
|
||||
* The SAML sign-in button draws a generic key glyph. It used to be filled black, which vanished
|
||||
* on the dark login surface; it now takes the button's own text colour, so it reads in every
|
||||
* mode and theme. SAML is switched on by rewriting `/api/config` the way librechat.yaml would.
|
||||
*/
|
||||
test.use({ storageState: { cookies: [], origins: [] } });
|
||||
|
||||
test('the SAML sign-in glyph is painted with the button text colour @scenario:saml-login-glyph-follows-button-text', async ({
|
||||
page,
|
||||
}) => {
|
||||
await page.route(
|
||||
(url) => url.pathname === '/api/config',
|
||||
async (route) => {
|
||||
const response = await route.fetch();
|
||||
const body = await response.json();
|
||||
await route.fulfill({
|
||||
response,
|
||||
json: {
|
||||
...body,
|
||||
socialLoginEnabled: true,
|
||||
samlLoginEnabled: true,
|
||||
samlImageUrl: '',
|
||||
samlLabel: 'SAML',
|
||||
socialLogins: ['saml'],
|
||||
},
|
||||
});
|
||||
},
|
||||
);
|
||||
|
||||
await page.goto('/login', { timeout: 15_000 });
|
||||
const button = page.getByRole('link', { name: 'SAML' });
|
||||
await expect(button).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
const paint = await button.evaluate((link) => {
|
||||
const glyph = link.querySelector('svg g');
|
||||
return {
|
||||
text: getComputedStyle(link).color,
|
||||
glyph: glyph ? getComputedStyle(glyph).fill : null,
|
||||
};
|
||||
});
|
||||
expect(paint.glyph).toBe(paint.text);
|
||||
});
|
||||
|
|
@ -2385,11 +2385,6 @@
|
|||
"count": 7
|
||||
}
|
||||
},
|
||||
"packages/client/src/svgs/SamlIcon.tsx": {
|
||||
"shadcn/no-raw-colors": {
|
||||
"count": 1
|
||||
}
|
||||
},
|
||||
"packages/client/src/svgs/SendMessageIcon.tsx": {
|
||||
"shadcn/no-inline-styles": {
|
||||
"count": 1
|
||||
|
|
|
|||
98
packages/client/src/components/PixelCard.spec.tsx
Normal file
98
packages/client/src/components/PixelCard.spec.tsx
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
import { render, waitFor } from '@testing-library/react';
|
||||
import PixelCard from './PixelCard';
|
||||
|
||||
/** The canvas draws with whatever the palette resolved to, so the test reads what the card
|
||||
* asked the page for: which theme variables, and whether it asks again after a theme change. */
|
||||
describe('PixelCard palette', () => {
|
||||
let fillStyles: string[];
|
||||
let channels: Record<string, string>;
|
||||
|
||||
beforeEach(() => {
|
||||
fillStyles = [];
|
||||
jest.spyOn(HTMLCanvasElement.prototype, 'getContext').mockImplementation(function () {
|
||||
return {
|
||||
clearRect: jest.fn(),
|
||||
fillRect: jest.fn(),
|
||||
set fillStyle(value: string) {
|
||||
fillStyles.push(value);
|
||||
},
|
||||
} as unknown as CanvasRenderingContext2D;
|
||||
});
|
||||
jest.spyOn(HTMLElement.prototype, 'getBoundingClientRect').mockReturnValue({
|
||||
width: 10,
|
||||
height: 10,
|
||||
} as DOMRect);
|
||||
channels = {
|
||||
'--surface-primary-alt': '1 2 3',
|
||||
'--surface-tertiary': '1 2 3',
|
||||
'--border-medium': '1 2 3',
|
||||
};
|
||||
const computed = window.getComputedStyle.bind(window);
|
||||
jest.spyOn(window, 'getComputedStyle').mockImplementation((element) => {
|
||||
const style = computed(element);
|
||||
return {
|
||||
...style,
|
||||
getPropertyValue: (name: string) =>
|
||||
name.startsWith('--') ? (channels[name] ?? '') : style.getPropertyValue(name),
|
||||
} as CSSStyleDeclaration;
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
jest.restoreAllMocks();
|
||||
document.documentElement.className = '';
|
||||
});
|
||||
|
||||
it('draws the default variant from theme variables', async () => {
|
||||
render(<PixelCard progress={1} />);
|
||||
|
||||
await waitFor(() => expect(fillStyles).toContain('rgb(1 2 3)'));
|
||||
expect(fillStyles.every((style) => style === 'rgb(1 2 3)')).toBe(true);
|
||||
});
|
||||
|
||||
it('draws each default slot from its own theme variable, and currentColor when one is unset', async () => {
|
||||
channels = { '--surface-primary-alt': '1 1 1', '--surface-tertiary': '2 2 2' };
|
||||
jest
|
||||
.spyOn(HTMLElement.prototype, 'getBoundingClientRect')
|
||||
.mockReturnValue({ width: 200, height: 200 } as DOMRect);
|
||||
render(<PixelCard progress={1} />);
|
||||
|
||||
await waitFor(() => expect(fillStyles.length).toBeGreaterThan(0));
|
||||
expect(new Set(fillStyles)).toEqual(new Set(['rgb(1 1 1)', 'rgb(2 2 2)', 'currentColor']));
|
||||
});
|
||||
|
||||
it('keeps an explicit colors prop as given', async () => {
|
||||
render(<PixelCard progress={1} colors="#123456" />);
|
||||
|
||||
await waitFor(() => expect(fillStyles).toContain('#123456'));
|
||||
expect(fillStyles.every((style) => style === '#123456')).toBe(true);
|
||||
});
|
||||
|
||||
it('re-reads the palette when the theme changes', async () => {
|
||||
render(<PixelCard progress={1} />);
|
||||
await waitFor(() => expect(fillStyles).toContain('rgb(1 2 3)'));
|
||||
|
||||
fillStyles = [];
|
||||
channels = {
|
||||
'--surface-primary-alt': '9 9 9',
|
||||
'--surface-tertiary': '9 9 9',
|
||||
'--border-medium': '9 9 9',
|
||||
};
|
||||
document.documentElement.classList.add('dark');
|
||||
|
||||
await waitFor(() => expect(fillStyles).toContain('rgb(9 9 9)'));
|
||||
});
|
||||
|
||||
it('keeps its pixels when an unrelated root variable changes', async () => {
|
||||
render(<PixelCard progress={1} />);
|
||||
await waitFor(() => expect(fillStyles).toContain('rgb(1 2 3)'));
|
||||
const measure = HTMLElement.prototype.getBoundingClientRect as jest.Mock;
|
||||
const layouts = measure.mock.calls.length;
|
||||
|
||||
document.documentElement.style.setProperty('--message-scrollbar-gutter', '8px');
|
||||
await new Promise((resolve) => setTimeout(resolve, 50));
|
||||
|
||||
expect(measure.mock.calls.length).toBe(layouts);
|
||||
document.documentElement.style.removeProperty('--message-scrollbar-gutter');
|
||||
});
|
||||
});
|
||||
|
|
@ -139,13 +139,36 @@ const getEffectiveSpeed = (value: number, reducedMotion: boolean) => {
|
|||
|
||||
const clamp = (n: number, min = 0, max = 1) => Math.min(Math.max(n, min), max);
|
||||
|
||||
/** The default palette names theme channel variables, read off the card when the pixels are
|
||||
* laid out, so the canvas draws the active theme instead of a fixed light palette. */
|
||||
const VARIANTS = {
|
||||
default: { gap: 5, speed: 35, colors: '#f8fafc,#f1f5f9,#cbd5e1', noFocus: false },
|
||||
default: {
|
||||
gap: 5,
|
||||
speed: 35,
|
||||
colors: '--surface-primary-alt,--surface-tertiary,--border-medium',
|
||||
noFocus: false,
|
||||
},
|
||||
/** Decorative presets no theme role reproduces; kept as given, like a `colors` prop. */
|
||||
blue: { gap: 10, speed: 25, colors: '#e0f2fe,#7dd3fc,#0ea5e9', noFocus: false },
|
||||
yellow: { gap: 3, speed: 20, colors: '#fef08a,#fde047,#eab308', noFocus: false },
|
||||
pink: { gap: 6, speed: 80, colors: '#fecdd3,#fda4af,#e11d48', noFocus: true },
|
||||
} as const;
|
||||
|
||||
/** Resolves `--token` entries to the element's channel triplet; any other entry is a CSS color
|
||||
* the caller supplied and passes through. A token the page does not define falls back to the
|
||||
* canvas ink rather than drawing nothing. */
|
||||
const resolvePalette = (palette: string, element: Element): string[] => {
|
||||
const style = getComputedStyle(element);
|
||||
return palette.split(',').map((entry) => {
|
||||
const color = entry.trim();
|
||||
if (!color.startsWith('--')) {
|
||||
return color;
|
||||
}
|
||||
const channels = style.getPropertyValue(color).trim();
|
||||
return channels ? `rgb(${channels})` : 'currentColor';
|
||||
});
|
||||
};
|
||||
|
||||
interface PixelCardProps {
|
||||
variant?: keyof typeof VARIANTS;
|
||||
gap?: number;
|
||||
|
|
@ -262,7 +285,7 @@ export default function PixelCard({
|
|||
canvasRef.current.width = Math.floor(cw);
|
||||
canvasRef.current.height = Math.floor(ch);
|
||||
|
||||
const cols = palette.split(',');
|
||||
const cols = resolvePalette(palette, containerRef.current);
|
||||
const px: Pixel[] = [];
|
||||
|
||||
const cx = cw / 2;
|
||||
|
|
@ -318,11 +341,34 @@ export default function PixelCard({
|
|||
if (containerRef.current) {
|
||||
obs.observe(containerRef.current);
|
||||
}
|
||||
/** A mode switch or an applied theme rewrites the root's class or inline variables, which
|
||||
* the resolved palette has already been read from. The root's inline style also carries
|
||||
* unrelated variables (scrollbar gutter, font size), so the pixels are laid out again only
|
||||
* when the palette itself resolves differently. */
|
||||
let resolved = containerRef.current
|
||||
? resolvePalette(palette, containerRef.current).join(',')
|
||||
: '';
|
||||
const themeObs = new MutationObserver(() => {
|
||||
if (!containerRef.current) {
|
||||
return;
|
||||
}
|
||||
const next = resolvePalette(palette, containerRef.current).join(',');
|
||||
if (next === resolved) {
|
||||
return;
|
||||
}
|
||||
resolved = next;
|
||||
initPixels();
|
||||
});
|
||||
themeObs.observe(document.documentElement, {
|
||||
attributes: true,
|
||||
attributeFilter: ['class', 'style'],
|
||||
});
|
||||
return () => {
|
||||
obs.disconnect();
|
||||
themeObs.disconnect();
|
||||
cancelAnimationFrame(animationRef.current!);
|
||||
};
|
||||
}, [initPixels]);
|
||||
}, [initPixels, palette]);
|
||||
|
||||
const hoverIn = () => progressRef.current === undefined && startAnim('appear');
|
||||
const hoverOut = () => progressRef.current === undefined && startAnim('disappear');
|
||||
|
|
@ -355,7 +401,7 @@ export default function PixelCard({
|
|||
>
|
||||
<div
|
||||
className={cn(
|
||||
'relative isolate grid select-none place-items-center overflow-hidden rounded-lg border border-border-light shadow-md transition-colors duration-200 ease-in-out',
|
||||
'border-border-light relative isolate grid place-items-center overflow-hidden rounded-lg border shadow-md transition-colors duration-200 ease-in-out select-none',
|
||||
className,
|
||||
)}
|
||||
style={{
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ export default function CodeyIcon({
|
|||
// height="100%"
|
||||
width={size}
|
||||
height={size}
|
||||
className={cn('dark:fill-white', className)}
|
||||
className={cn('fill-text-primary', className)}
|
||||
viewBox="0 0 18 18"
|
||||
preserveAspectRatio="xMidYMid meet"
|
||||
focusable="false"
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ export default function SamlIcon(): JSX.Element {
|
|||
className="h-5 w-5"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<g fill="#000000">
|
||||
<g fill="currentColor">
|
||||
<path d="M7.754 2l.463.41c.343.304.687.607 1.026.915C11.44 5.32 13.3 7.565 14.7 10.149c.072.132.137.268.202.403l.098.203-.108.057-.081-.115-.21-.299-.147-.214c-1.019-1.479-2.04-2.96-3.442-4.145a6.563 6.563 0 00-1.393-.904c-1.014-.485-1.916-.291-2.69.505-.736.757-1.118 1.697-1.463 2.653-.045.123-.092.245-.139.367l-.082.215-.172-.055c.1-.348.192-.698.284-1.049.21-.795.42-1.59.712-2.356.31-.816.702-1.603 1.093-2.39.169-.341.338-.682.5-1.025h.092z" />
|
||||
|
||||
<path d="M8.448 11.822c-1.626.77-5.56 1.564-7.426 1.36C.717 11.576 3.71 4.05 5.18 2.91l-.095.218a4.638 4.638 0 01-.138.303l-.066.129c-.76 1.462-1.519 2.926-1.908 4.53a7.482 7.482 0 00-.228 1.689c-.01 1.34.824 2.252 2.217 2.309.67.027 1.347-.043 2.023-.114.294-.03.587-.061.88-.084.108-.008.214-.021.352-.039l.231-.028z" />
|
||||
|
|
|
|||
41
packages/client/src/theme/allowlist.md
Normal file
41
packages/client/src/theme/allowlist.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# Colours outside the theme
|
||||
|
||||
Every colour in `client/src` and `packages/client/src` that the theme-leakage sweep reached comes from a semantic theme role, except the ones below. Each is a colour that must not follow the theme: a brand mark, artwork, media overlays, a third party's surface, a document that leaves the app, or the theme definitions themselves. An entry names the file, what the literal paints and why the theme does not own it.
|
||||
|
||||
The sweep skipped files an open pull request was editing; those, with their counts, are listed in berry-13/LibreChat#195, and the avatar colours that still need roles in berry-13/LibreChat#194. Until those land, a file absent from this list is not evidence that it holds no literal colour.
|
||||
|
||||
A literal the design lint can see stays recorded in `eslint-suppressions.json` (inline disables
|
||||
of the design rules are rejected by the static checks), so its count there is the exception, not
|
||||
debt; the file-scoped allow entry for these paths belongs in `eslint.config.mjs`. Everything else
|
||||
is invisible to the lint (CSS, strings passed to a canvas or an iframe), so this list is the record.
|
||||
|
||||
Adding an entry needs the same bar: if a theme author would reasonably want to recolour it, it
|
||||
is a role, not an exception.
|
||||
|
||||
## Theme definitions
|
||||
|
||||
| File | Why |
|
||||
| -------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `packages/client/src/theme/themes/*.ts`, `themes/clickui.json` | The palettes themselves: these are the values roles resolve to. |
|
||||
| `packages/client/src/theme/registry.ts` | Theme resolution and fallbacks written in channel triplets. |
|
||||
| `packages/client/src/theme/tokens.css` | Maps each role to `rgb(var(--role))`; no literal colour. |
|
||||
|
||||
## Brand marks and artwork
|
||||
|
||||
| File | Why |
|
||||
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `packages/client/src/svgs/GoogleIcon.tsx` | Google's multicolour mark, fixed by its brand guidelines. |
|
||||
| `packages/client/src/svgs/FacebookIcon.tsx` | Facebook's mark, fixed by its brand guidelines. |
|
||||
| `packages/client/src/svgs/DiscordIcon.tsx` | Discord's mark, fixed by its brand guidelines. |
|
||||
| `packages/client/src/svgs/GeminiIcon.tsx` | Gemini's gradient mark, fixed by its brand guidelines. |
|
||||
| `packages/client/src/svgs/PaLMIcon.tsx` | PaLM's multicolour mark, fixed by its brand guidelines. |
|
||||
| `packages/client/src/svgs/BirthdayIcon.tsx` | A multicolour illustration; the palette is artwork, not a UI role. |
|
||||
| `packages/client/src/components/PixelCard.tsx` | The `blue`, `yellow` and `pink` presets are decorative palettes a caller opts into, like the `colors` prop; the app renders only the default, which reads theme roles. |
|
||||
| `packages/client/src/icons/provider/registry.ts`, `icons/provider/Avatar.tsx` | Provider brand colours, each already behind a `--provider-*` variable a deployment can override; the literal is only the fallback. |
|
||||
|
||||
## Elevation ink in library stylesheets
|
||||
|
||||
| File | Why |
|
||||
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `packages/client/src/components/Dropdown.css` | Popover shadows in black alpha. The app paints `.popover-ui` from its own copy of these rules in `client/src/style.css`, so moving either copy to `--theme-shadow-lg` needs both edited together. |
|
||||
| `packages/client/src/components/Tooltip.css` | Tooltip shadows are smaller than any step of the theme shadow scale; black alpha ink, dropped in high contrast where the border takes over. |
|
||||
Loading…
Add table
Add a link
Reference in a new issue