mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-16 13:00:55 +00:00
🎚️ refactor: Drop Inline Pointer Styles From Select and Menu Primitives (#16704)
* refactor: Move Select and Menu Pointer Events to Classes DropdownPopup and SelectContent re-enabled pointer events inside modal dialogs through inline style, which kept a no-inline-styles suppression on both primitives. Both now apply pointer-events-auto as a class and keep only the runtime z-index inline. The Select item indicator box takes the icon size role instead of a fixed h-3.5 w-3.5. * test: Cover Popover Picks Inside Modal Dialogs * test: Open Settings From the Drawer and Tag Indicator Scenarios * test: Let Each Verify Project Set the Color Mode * test: Measure the Select Indicator After the List Settles * test: Drop the Settings Select Pick That Never Reached a Dialog
This commit is contained in:
parent
a2b184b231
commit
4e325f184c
7 changed files with 169 additions and 33 deletions
140
e2e/specs/mock/scenarios/nested-popovers.spec.ts
Normal file
140
e2e/specs/mock/scenarios/nested-popovers.spec.ts
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
import { expect, test } from '@playwright/test';
|
||||
import type { Page } from '@playwright/test';
|
||||
import { NEW_CHAT_PATH } from '../helpers';
|
||||
import { openSidebar } from './sidebar';
|
||||
|
||||
/**
|
||||
* A modal OGDialog parks `pointer-events: none` on the body, so a menu portaled out of it inherits
|
||||
* `none` unless it turns pointer events back on for itself. DropdownPopup does that with a class,
|
||||
* not an inline style, and its menu must still take a real mouse pick while the dialog is open.
|
||||
* The Select's check indicator draws its box at the icon size role, so a theme that resizes icons
|
||||
* resizes the box with the glyph inside it.
|
||||
*/
|
||||
|
||||
/** Names an icon size apart from the default, so a box still drawn at a fixed size shows. */
|
||||
const REFERENCE_ICON_THEME = {
|
||||
version: 1,
|
||||
name: 'e2e-icon-reference',
|
||||
modes: {
|
||||
light: { appearance: { iconSize: '1.25rem' } },
|
||||
dark: { appearance: { iconSize: '1.25rem' } },
|
||||
},
|
||||
} as const;
|
||||
|
||||
/** Leaves the color mode to the project (light, dark or mobile), so every scenario runs in each. */
|
||||
async function useTheme(page: Page, definition?: { name: string }) {
|
||||
await page.addInitScript((stored) => {
|
||||
localStorage.removeItem('theme-colors');
|
||||
localStorage.removeItem('theme-name');
|
||||
if (stored) {
|
||||
localStorage.setItem('theme-definition', JSON.stringify(stored));
|
||||
localStorage.setItem('theme-source', 'definition');
|
||||
} else {
|
||||
localStorage.removeItem('theme-definition');
|
||||
localStorage.removeItem('theme-source');
|
||||
}
|
||||
}, definition ?? null);
|
||||
}
|
||||
|
||||
/** The stateful workspace Select only renders when the agents endpoint offers stateful sessions. */
|
||||
async function offerStatefulSessions(page: Page) {
|
||||
await page.route('**/api/endpoints', async (route) => {
|
||||
const response = await route.fetch();
|
||||
const endpoints = await response.json();
|
||||
const agents = endpoints.agents ?? {};
|
||||
agents.capabilities = [...(agents.capabilities ?? []), 'stateful_code_sessions'];
|
||||
endpoints.agents = agents;
|
||||
await route.fulfill({ response, json: endpoints });
|
||||
});
|
||||
}
|
||||
|
||||
/** Opens the Settings Select's list. Only its geometry is read, which does not depend on how the
|
||||
* list layers against the Settings dialog. */
|
||||
async function openWorkspaceSelect(page: Page) {
|
||||
await page.goto(NEW_CHAT_PATH, { timeout: 15000 });
|
||||
/** Mobile keeps the account menu in the drawer. */
|
||||
await openSidebar(page);
|
||||
await page.getByTestId('nav-user').locator('visible=true').first().click();
|
||||
await page.getByRole('menuitem', { name: 'Settings' }).click();
|
||||
const dialog = page.getByRole('dialog');
|
||||
await expect(dialog.getByRole('heading', { name: 'Settings', exact: true })).toBeVisible({
|
||||
timeout: 15000,
|
||||
});
|
||||
await dialog.getByRole('tab', { name: /data/i }).click();
|
||||
const trigger = dialog.getByTestId('default-stateful-workspace');
|
||||
await expect(trigger).toBeVisible();
|
||||
await trigger.click();
|
||||
const listbox = page.getByRole('listbox');
|
||||
await expect(listbox).toBeVisible();
|
||||
/** The list zooms in, so a box read before the animation settles is scaled. */
|
||||
await listbox.evaluate((element) =>
|
||||
Promise.all(element.getAnimations({ subtree: true }).map((animation) => animation.finished)),
|
||||
);
|
||||
}
|
||||
|
||||
/** The checked option's indicator box is `expected` square and its glyph fills it exactly. */
|
||||
async function expectIndicator(page: Page, expected: string) {
|
||||
const checked = page.getByRole('option', { selected: true });
|
||||
const box = checked.locator('> span').first();
|
||||
const glyph = checked.locator('svg');
|
||||
await expect(glyph).toBeVisible();
|
||||
const [boxRect, glyphRect] = await Promise.all([box.boundingBox(), glyph.boundingBox()]);
|
||||
expect(boxRect).not.toBeNull();
|
||||
expect(glyphRect).not.toBeNull();
|
||||
expect(`${boxRect?.width}px`).toBe(expected);
|
||||
expect(`${boxRect?.height}px`).toBe(expected);
|
||||
/** The glyph sits inside its box rather than spilling past it. */
|
||||
expect(glyphRect?.width).toBe(boxRect?.width);
|
||||
expect(glyphRect?.x).toBe(boxRect?.x);
|
||||
}
|
||||
|
||||
test.describe('popovers inside a modal dialog', () => {
|
||||
test('the role menu inside Admin Settings takes a mouse pick @scenario:menu-in-dialog-takes-pointer', async ({
|
||||
page,
|
||||
}) => {
|
||||
await useTheme(page);
|
||||
await page.goto('/agents/all', { timeout: 15000 });
|
||||
await page.getByRole('button', { name: 'Admin Settings' }).click();
|
||||
const dialog = page.getByRole('dialog');
|
||||
await expect(dialog).toBeVisible({ timeout: 15000 });
|
||||
|
||||
const trigger = dialog.locator('button[aria-haspopup="menu"]');
|
||||
const before = (await trigger.innerText()).trim();
|
||||
await trigger.click();
|
||||
const menu = page.getByRole('menu');
|
||||
await expect(menu).toBeVisible();
|
||||
|
||||
expect(await page.evaluate(() => getComputedStyle(document.body).pointerEvents)).toBe('none');
|
||||
expect(await menu.evaluate((element) => getComputedStyle(element).pointerEvents)).toBe('auto');
|
||||
|
||||
const items = menu.getByRole('menuitem');
|
||||
await expect(items.first()).toBeVisible();
|
||||
const labels = (await items.allInnerTexts()).map((label) => label.trim());
|
||||
const next = labels.find((label) => label !== before);
|
||||
expect(next).toBeTruthy();
|
||||
await items
|
||||
.filter({ hasText: next as string })
|
||||
.first()
|
||||
.click();
|
||||
await expect(menu).toBeHidden();
|
||||
await expect(trigger).toHaveText(next as string);
|
||||
});
|
||||
|
||||
test('the Select check indicator box takes the default icon size @scenario:select-indicator-icon-role-default', async ({
|
||||
page,
|
||||
}) => {
|
||||
await offerStatefulSessions(page);
|
||||
await useTheme(page);
|
||||
await openWorkspaceSelect(page);
|
||||
await expectIndicator(page, '16px');
|
||||
});
|
||||
|
||||
test('the Select check indicator box follows a theme icon size @scenario:select-indicator-icon-role-reference', async ({
|
||||
page,
|
||||
}) => {
|
||||
await offerStatefulSessions(page);
|
||||
await useTheme(page, REFERENCE_ICON_THEME);
|
||||
await openWorkspaceSelect(page);
|
||||
await expectIndicator(page, '20px');
|
||||
});
|
||||
});
|
||||
|
|
@ -2154,11 +2154,6 @@
|
|||
"count": 1
|
||||
}
|
||||
},
|
||||
"packages/client/src/components/DropdownPopup.tsx": {
|
||||
"shadcn/no-inline-styles": {
|
||||
"count": 1
|
||||
}
|
||||
},
|
||||
"packages/client/src/components/FileUpload.tsx": {
|
||||
"shadcn/no-inline-styles": {
|
||||
"count": 1
|
||||
|
|
@ -2184,11 +2179,6 @@
|
|||
"count": 2
|
||||
}
|
||||
},
|
||||
"packages/client/src/components/Select.tsx": {
|
||||
"shadcn/no-inline-styles": {
|
||||
"count": 1
|
||||
}
|
||||
},
|
||||
"packages/client/src/components/SplitText.tsx": {
|
||||
"shadcn/no-inline-styles": {
|
||||
"count": 7
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ describe('DropdownPopup', () => {
|
|||
|
||||
const menu = document.getElementById('portal-click-test-menu');
|
||||
expect(menu).not.toBeNull();
|
||||
expect(menu?.style.pointerEvents).toBe('auto');
|
||||
expect(menu).toHaveClass('pointer-events-auto');
|
||||
|
||||
document.body.style.pointerEvents = '';
|
||||
});
|
||||
|
|
|
|||
|
|
@ -89,12 +89,12 @@ const Menu: React.FC<MenuProps> = ({
|
|||
finalFocus={finalFocus}
|
||||
unmountOnHide={unmountOnHide}
|
||||
preserveTabOrder={preserveTabOrder}
|
||||
style={{ zIndex, ...style }}
|
||||
/* Portaled menus land beside modal OGDialog layers, which set
|
||||
`pointer-events: none` on body and re-enable it only on their own
|
||||
content. Without this the menu inherits `none` and its items become
|
||||
hit-transparent (danny-avila/LibreChat#14487). */
|
||||
style={{ zIndex, pointerEvents: 'auto', ...style }}
|
||||
className={cn('popover-ui', className)}
|
||||
content. Without `pointer-events-auto` the menu inherits `none` and its
|
||||
items become hit-transparent (danny-avila/LibreChat#14487). */
|
||||
className={cn('popover-ui pointer-events-auto', className)}
|
||||
{...props}
|
||||
>
|
||||
{items
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ import * as React from 'react';
|
|||
import * as SelectPrimitive from '@radix-ui/react-select';
|
||||
import { CaretSortIcon, CheckIcon, ChevronDownIcon, ChevronUpIcon } from '@radix-ui/react-icons';
|
||||
import { cn, disabledFillClasses, disabledInkClasses } from '~/utils';
|
||||
import { useNestedPopoverStyle } from './OriginalDialog';
|
||||
import { useDialogDepth, usePopoverZIndex } from './OriginalDialog';
|
||||
|
||||
// @ts-ignore - Radix UI type conflicts with React types
|
||||
const Select: React.FC<SelectPrimitive.SelectProps> = SelectPrimitive.Root;
|
||||
|
|
@ -83,17 +83,21 @@ const SelectContent: React.ForwardRefExoticComponent<
|
|||
React.ElementRef<typeof SelectPrimitive.Content>,
|
||||
React.ComponentPropsWithoutRef<typeof SelectPrimitive.Content>
|
||||
>(({ className = '', children, position = 'popper', style, ...props }, ref) => {
|
||||
const nestedStyle = useNestedPopoverStyle();
|
||||
const nested = useDialogDepth() > 0;
|
||||
const zIndex = usePopoverZIndex();
|
||||
return (
|
||||
<SelectPrimitive.Portal>
|
||||
<SelectPrimitive.Content
|
||||
ref={ref}
|
||||
style={{ ...nestedStyle, ...style }}
|
||||
/* Inside a dialog the list must layer over it and accept pointer events
|
||||
(see `useNestedPopoverStyle`); elsewhere `z-40` applies. */
|
||||
style={{ zIndex: nested ? zIndex : undefined, ...style }}
|
||||
className={cn(
|
||||
'border-border-light bg-surface-secondary text-text-primary data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 relative z-40 max-h-96 min-w-[8rem] overflow-hidden rounded-md border shadow-md',
|
||||
position === 'popper'
|
||||
? 'data-[side=bottom]:translate-y-1 data-[side=left]:-translate-x-1 data-[side=right]:translate-x-1 data-[side=top]:-translate-y-1'
|
||||
: '',
|
||||
nested && 'pointer-events-auto',
|
||||
className,
|
||||
)}
|
||||
position={position}
|
||||
|
|
@ -149,7 +153,7 @@ const SelectItem: React.ForwardRefExoticComponent<
|
|||
)}
|
||||
{...props}
|
||||
>
|
||||
<span className="absolute right-2 flex h-3.5 w-3.5 items-center justify-center">
|
||||
<span className="size-theme-icon absolute right-2 flex items-center justify-center">
|
||||
<SelectPrimitive.ItemIndicator>
|
||||
<CheckIcon className="size-theme-icon" />
|
||||
</SelectPrimitive.ItemIndicator>
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ describe('portaled popovers inside a dialog', () => {
|
|||
|
||||
const listbox = screen.getByRole('listbox');
|
||||
expect(zIndexOf(listbox)).toBeGreaterThan(DIALOG_CONTENT_Z_INDEX);
|
||||
expect(listbox.style.pointerEvents).toBe('auto');
|
||||
expect(listbox).toHaveClass('pointer-events-auto');
|
||||
});
|
||||
|
||||
it('opens a hover card above the dialog content it belongs to', () => {
|
||||
|
|
@ -95,6 +95,7 @@ describe('portaled popovers inside a dialog', () => {
|
|||
const card = screen.getByText('What stateful sessions do');
|
||||
expect(listbox.style.zIndex).toBe('');
|
||||
expect(listbox).toHaveClass('z-40');
|
||||
expect(listbox).not.toHaveClass('pointer-events-auto');
|
||||
expect(card.style.zIndex).toBe('');
|
||||
expect(card).toHaveClass('z-50');
|
||||
});
|
||||
|
|
|
|||
|
|
@ -28,21 +28,22 @@ const primitives: Record<string, string[]> = {
|
|||
Tooltip: ['Tooltip.tsx', 'Tooltip.css'],
|
||||
};
|
||||
|
||||
const themeDriven = ['Button', 'Input', 'Dialog', 'Tabs', 'Switch', 'Checkbox', 'Table', 'Tooltip'];
|
||||
const themeDriven = [
|
||||
'Button',
|
||||
'Input',
|
||||
'Dialog',
|
||||
'Menu',
|
||||
'Tabs',
|
||||
'Switch',
|
||||
'Checkbox',
|
||||
'Table',
|
||||
'Tooltip',
|
||||
];
|
||||
|
||||
/** What the two others still hard-code, and why it stays. */
|
||||
/** What the other still hard-codes, and why it stays. */
|
||||
const remaining: Record<string, string[]> = {
|
||||
/** The content's nested-popover layering is a runtime style; the item indicator box, the list's
|
||||
* scroll cap and its minimum width have no role. */
|
||||
Select: [
|
||||
'Select.tsx: arbitrary size min-w-[8rem]',
|
||||
'Select.tsx: fixed size h-3.5',
|
||||
'Select.tsx: fixed size h-96',
|
||||
'Select.tsx: fixed size w-3.5',
|
||||
'Select.tsx: suppression shadcn/no-inline-styles',
|
||||
],
|
||||
/** The menu's z-index comes from the popover stack at runtime. */
|
||||
Menu: ['DropdownPopup.tsx: suppression shadcn/no-inline-styles'],
|
||||
/** The list's scroll cap and its minimum width have no role. */
|
||||
Select: ['Select.tsx: arbitrary size min-w-[8rem]', 'Select.tsx: fixed size h-96'],
|
||||
};
|
||||
|
||||
const suppressions: Record<string, Record<string, { count: number }>> = JSON.parse(
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue