Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

[Component Audit] Drawer: keep self-directed RTL motion on the logical edge (#7634)

Cindy Zhang738e671cab61
diff --git a/.changeset/drawer-self-directed-rtl.md b/.changeset/drawer-self-directed-rtl.md
new file mode 100644
index 0000000000..571b13ad7c
--- /dev/null
+++ b/.changeset/drawer-self-directed-rtl.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] `Drawer` now slides from the correct logical edge when `dir="rtl"` is set directly on the drawer, matching inherited right-to-left regions.
+
+@cixzhang
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 9db2e37e53..fa0d9dd437 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -2464,6 +2464,37 @@ jobs:
retention-days: 30
if-no-files-found: error
+ # Drawer audit evidence covers modal/non-modal, both logical sides,
+ # root-owned RTL, purpose, narrow widths, custom theming, padding, and
+ # sibling stacking. Axe and the sensor matrix both run even if one fails.
+ - name: Run Drawer audit browser evidence
+ if: ${{ !cancelled() && github.event_name == 'pull_request' && startsWith(github.event.pull_request.title, '[Component Audit] Drawer:') }}
+ env:
+ ASTRYX_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+ run: |
+ status=0
+ node .github/scripts/accessibility-audit.js \
+ --storybook-dir apps/storybook/dist \
+ --output drawer-a11y-report.json \
+ --components Drawer \
+ --baseline .github/a11y-baseline.json \
+ --fail-on-new || status=1
+ pnpm exec playwright test \
+ packages/core/src/Drawer/__tests__/DrawerAudit.a11y.chromium.spec.ts \
+ --project chromium || status=1
+ exit "$status"
+
+ - name: Upload Drawer audit evidence
+ if: always() && github.event_name == 'pull_request' && startsWith(github.event.pull_request.title, '[Component Audit] Drawer:')
+ uses: actions/upload-artifact@v7
+ with:
+ name: drawer-audit-evidence-${{ needs.build-storybook.outputs.short_hash }}
+ path: |
+ drawer-a11y-report.json
+ test-results/drawer-audit-evidence/
+ retention-days: 30
+ if-no-files-found: error
+
# DateInput's open-state audit story uses a play function to open the
# popover. Restricting this focused pass to that story lets the selector
# wait bind axe to the Calendar dialog without making every DateInput story
diff --git a/apps/storybook/stories/Drawer.stories.tsx b/apps/storybook/stories/Drawer.stories.tsx
index 01ccbe0568..a3637e79ff 100644
--- a/apps/storybook/stories/Drawer.stories.tsx
+++ b/apps/storybook/stories/Drawer.stories.tsx
@@ -221,6 +221,85 @@ export const Sides: Story = {
},
};
+function selfDirectedRtlStory(side: 'start' | 'end'): Story {
+ return {
+ name: `Self-applied RTL ${side} audit`,
+ parameters: {docs: {disable: true}},
+ render: () => {
+ const [isOpen, setIsOpen] = useState(false);
+ return (
+ <>
+ <Button
+ label={`Open self-directed RTL ${side} drawer`}
+ onClick={() => setIsOpen(true)}
+ />
+ <Drawer
+ isOpen={isOpen}
+ onOpenChange={setIsOpen}
+ label="Deployment details"
+ side={side}
+ dir="rtl">
+ <Layout
+ header={
+ <DrawerHeader
+ title="Deployment details"
+ onOpenChange={setIsOpen}
+ />
+ }
+ content={
+ <LayoutContent>
+ <Text type="body">The Drawer root owns this RTL region.</Text>
+ </LayoutContent>
+ }
+ />
+ </Drawer>
+ </>
+ );
+ },
+ };
+}
+
+export const SelfDirectedRtlStart = selfDirectedRtlStory('start');
+export const SelfDirectedRtlEnd = selfDirectedRtlStory('end');
+
+export const NestedLtrOverride: Story = {
+ name: 'Nested LTR override audit',
+ parameters: {docs: {disable: true}},
+ render: () => {
+ const [isOpen, setIsOpen] = useState(false);
+ return (
+ <>
+ <Button
+ label="Open nested LTR drawer"
+ onClick={() => setIsOpen(true)}
+ />
+ <Drawer
+ isOpen={isOpen}
+ onOpenChange={setIsOpen}
+ label="Deployment details"
+ side="end"
+ dir="ltr">
+ <Layout
+ header={
+ <DrawerHeader
+ title="Deployment details"
+ onOpenChange={setIsOpen}
+ />
+ }
+ content={
+ <LayoutContent>
+ <Text type="body">
+ This local LTR region overrides the ambient RTL page.
+ </Text>
+ </LayoutContent>
+ }
+ />
+ </Drawer>
+ </>
+ );
+ },
+};
+
/**
* `width` is the desktop budget: a number of pixels or any CSS length.
* Narrow the browser below 640px: each width remains an upper bound while
diff --git a/packages/core/src/Drawer/Drawer.spec.md b/packages/core/src/Drawer/Drawer.spec.md
index bacc47fdb7..f3e20409a6 100644
--- a/packages/core/src/Drawer/Drawer.spec.md
+++ b/packages/core/src/Drawer/Drawer.spec.md
@@ -239,11 +239,13 @@ Consumer prop syntax and examples remain in `Drawer.doc.mjs`.
- **AR5 — Close affordance.** Drawer provides no close control of its own. When
rendered, the `DrawerHeader` close action keeps its translated accessible name
and Button-owned keyboard/focus behavior in both presentations.
-- **AR6 — Direction and motion.** Logical inset placement follows computed
- direction; slide-direction mirroring currently requires a `[dir="rtl"]`
- ancestor. Self-applied `dir="rtl"` and CSS-only direction do not trigger
- transform mirroring. Motion reduces under `prefers-reduced-motion` without
- changing the final state.
+- **AR6 — Direction and motion.** Logical inset placement and slide-direction
+ mirroring follow DOM directionality from the nearest effective `dir` attribute,
+ including an explicit local override or an inherited direction. As required by
+ `design:bidirectionality`, a region whose direction differs from its ancestor
+ describes that direction in DOM `dir`; a CSS-only `direction` declaration is
+ not a supported substitute. Motion reduces under `prefers-reduced-motion`
+ without changing the final state.
## Design relationships
@@ -299,7 +301,7 @@ decide future target qualification.
| FR15 | `Drawer.test.tsx` purpose suite | `info`, `form`, `required`; modal and non-modal; a sibling behind a required drawer | A `form` drawer closes on a scrim click, a `required` drawer closes or lets Escape reach the drawer behind it, or its role semantics drift. | `audit:Drawer/behavior` |
| FR12 | source, `Drawer.doc.mjs`, `DrawerHeader.doc.mjs`, the `DrawerHeader` target test, and current target discovery | start/end root Panel and inherited container context | Current root target/axis or padding reset changes, or the record claims an unreachable child target or decides future admission. | `audit:Drawer/theming` |
| FR16 | `Drawer.test.tsx` container padding suites; `defineTheme.test.ts` drawer mapping; browser evidence | default, `padding` prop, theme `padding`, lone padded Section child, Layout composition | The published inset differs from the applied padding, the default drawer changes geometry, or the block-end safe area is lost or double-subtracted. | `audit:Drawer/theming` |
-| AR6 | side tests and source inspection plus Storybook ancestor-RTL audit | settled `end` placement under ancestor RTL; transform mirroring and reduced motion source-inspected | Audited settled placement or source-inspected ancestor mirroring/reduced-motion behavior changes without corresponding evidence. | `audit:Drawer/accessibility` |
+| AR6 | `DrawerDirection.test.tsx` DOM-direction and closed/entry parity suites plus exact-head Storybook RTL evidence | start/end; self-applied, inherited, and nested opposite `dir`; closed and opening transforms | Any effective DOM direction or local override moves the panel from a different edge than its logical placement, or closed and opening transforms diverge. | `audit:Drawer/accessibility` |
## Decision log
diff --git a/packages/core/src/Drawer/Drawer.tsx b/packages/core/src/Drawer/Drawer.tsx
index 0a68ec6b95..67f99819e4 100644
--- a/packages/core/src/Drawer/Drawer.tsx
+++ b/packages/core/src/Drawer/Drawer.tsx
@@ -153,8 +153,9 @@ const styles = stylex.create({
rendered: {
display: 'flex',
},
- // start/end transforms flip under RTL so the panel always slides in from
- // the edge it is anchored to.
+ // DOM directionality comes from the nearest effective `dir` attribute. A
+ // local override and an inherited region therefore agree with the logical
+ // edge the panel is anchored to.
end: {
insetInlineEnd: 0,
insetInlineStart: 'auto',
@@ -163,7 +164,7 @@ const styles = stylex.create({
borderInlineStartColor: colorVars['--color-border'],
transform: {
default: 'translateX(100%)',
- ':is([dir="rtl"] *)': 'translateX(-100%)',
+ ':dir(rtl)': 'translateX(-100%)',
},
},
endOpen: {
@@ -171,7 +172,7 @@ const styles = stylex.create({
default: 'translateX(0)',
'@starting-style': {
default: 'translateX(100%)',
- ':is([dir="rtl"] *)': 'translateX(-100%)',
+ ':dir(rtl)': 'translateX(-100%)',
},
},
},
@@ -183,7 +184,7 @@ const styles = stylex.create({
borderInlineEndColor: colorVars['--color-border'],
transform: {
default: 'translateX(-100%)',
- ':is([dir="rtl"] *)': 'translateX(100%)',
+ ':dir(rtl)': 'translateX(100%)',
},
},
startOpen: {
@@ -191,7 +192,7 @@ const styles = stylex.create({
default: 'translateX(0)',
'@starting-style': {
default: 'translateX(-100%)',
- ':is([dir="rtl"] *)': 'translateX(100%)',
+ ':dir(rtl)': 'translateX(100%)',
},
},
},
diff --git a/packages/core/src/Drawer/DrawerDirection.test.tsx b/packages/core/src/Drawer/DrawerDirection.test.tsx
new file mode 100644
index 0000000000..bdc21776e2
--- /dev/null
+++ b/packages/core/src/Drawer/DrawerDirection.test.tsx
@@ -0,0 +1,127 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file DrawerDirection.test.tsx
+ * @input Drawer closed transforms and the matching @starting-style declarations
+ * @output Regression coverage for resolved DOM LTR/RTL motion on both logical sides
+ * @position Focused direction contract; complements Drawer.test.tsx behavior coverage
+ */
+
+import {readFileSync} from 'node:fs';
+import {join} from 'node:path';
+import * as ts from 'typescript';
+import {describe, expect, it} from 'vitest';
+import {render, screen} from '@testing-library/react';
+import {Drawer} from './Drawer';
+
+function closedTransform(): string {
+ return getComputedStyle(screen.getByRole('dialog', {hidden: true})).transform;
+}
+
+describe.each([
+ {side: 'start' as const, ltr: 'translateX(-100%)', rtl: 'translateX(100%)'},
+ {side: 'end' as const, ltr: 'translateX(100%)', rtl: 'translateX(-100%)'},
+])('Drawer direction on side=$side', ({side, ltr, rtl}) => {
+ it('uses a self-applied RTL direction', () => {
+ render(
+ <Drawer
+ isOpen={false}
+ onOpenChange={() => {}}
+ label="Details"
+ side={side}
+ dir="rtl">
+ Content
+ </Drawer>,
+ );
+ expect(closedTransform()).toBe(rtl);
+ });
+
+ it('honors a nearer LTR override inside an RTL page', () => {
+ render(
+ <div dir="rtl">
+ <Drawer
+ isOpen={false}
+ onOpenChange={() => {}}
+ label="Details"
+ side={side}
+ dir="ltr">
+ Content
+ </Drawer>
+ </div>,
+ );
+ expect(closedTransform()).toBe(ltr);
+ });
+});
+
+const SOURCE = readFileSync(join(__dirname, 'Drawer.tsx'), 'utf8');
+
+function styleDefinition(name: string): ts.ObjectLiteralExpression {
+ const file = ts.createSourceFile(
+ 'Drawer.tsx',
+ SOURCE,
+ ts.ScriptTarget.Latest,
+ true,
+ ts.ScriptKind.TSX,
+ );
+ let found: ts.ObjectLiteralExpression | undefined;
+ const visit = (node: ts.Node) => {
+ if (
+ ts.isPropertyAssignment(node) &&
+ ts.isIdentifier(node.name) &&
+ node.name.text === name &&
+ ts.isObjectLiteralExpression(node.initializer)
+ ) {
+ found = node.initializer;
+ }
+ ts.forEachChild(node, visit);
+ };
+ visit(file);
+ if (found == null) {
+ throw new Error(`No style named "${name}" in Drawer.tsx`);
+ }
+ return found;
+}
+
+function property(style: ts.ObjectLiteralExpression, key: string): string {
+ const entry = style.properties.find(
+ candidate =>
+ ts.isPropertyAssignment(candidate) &&
+ (ts.isIdentifier(candidate.name) || ts.isStringLiteral(candidate.name)) &&
+ candidate.name.text === key,
+ );
+ if (entry == null) {
+ throw new Error(`No "${key}" in ${style.getText().slice(0, 40)}…`);
+ }
+ return (entry as ts.PropertyAssignment).initializer.getText();
+}
+
+describe.each([
+ {
+ side: 'start',
+ closed: 'start',
+ open: 'startOpen',
+ ltr: 'translateX(-100%)',
+ rtl: 'translateX(100%)',
+ },
+ {
+ side: 'end',
+ closed: 'end',
+ open: 'endOpen',
+ ltr: 'translateX(100%)',
+ rtl: 'translateX(-100%)',
+ },
+])('Drawer $side entry declaration', ({closed, open, ltr, rtl}) => {
+ it('parks closed on the computed logical edge', () => {
+ const transform = property(styleDefinition(closed), 'transform');
+ expect(transform).toContain(`default: '${ltr}'`);
+ expect(transform).toContain(`':dir(rtl)': '${rtl}'`);
+ });
+
+ it('starts opening from the same computed logical edge', () => {
+ const transform = property(styleDefinition(open), 'transform');
+ expect(transform).toContain("default: 'translateX(0)'");
+ expect(transform).toContain('@starting-style');
+ expect(transform).toContain(`default: '${ltr}'`);
+ expect(transform).toContain(`':dir(rtl)': '${rtl}'`);
+ });
+});
diff --git a/packages/core/src/Drawer/__tests__/DrawerAudit.a11y.chromium.spec.ts b/packages/core/src/Drawer/__tests__/DrawerAudit.a11y.chromium.spec.ts
new file mode 100644
index 0000000000..6247f4413c
--- /dev/null
+++ b/packages/core/src/Drawer/__tests__/DrawerAudit.a11y.chromium.spec.ts
@@ -0,0 +1,401 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file DrawerAudit.a11y.chromium.spec.ts
+ * @input Exact-head Core/Drawer Storybook fixtures in light/dark, neutral/custom themes, LTR/RTL, wide/narrow, modal/non-modal, purpose, padding, and stacked states
+ * @output Bounded screenshots and fail-closed sensor receipts for the Drawer whole-component audit
+ * @position Component-owned Night Watch browser evidence; CI runs it only for a Drawer component-audit pull request
+ */
+
+import {createHash} from 'node:crypto';
+import {execFileSync} from 'node:child_process';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import {expect, test, type Page} from '@playwright/test';
+import {holdMotionStill} from '@astryxdesign/a11y-spec/chromium';
+import {
+ DEFAULT_STORYBOOK_DIR,
+ serveStorybook,
+ type StaticServer,
+} from '@astryxdesign/a11y-spec/storybook';
+
+const OUTPUT = path.resolve('test-results/drawer-audit-evidence');
+const WIDE = {width: 1024, height: 768};
+const NARROW = {width: 320, height: 720};
+
+type Mode = 'light' | 'dark';
+type Direction = 'ltr' | 'rtl';
+type Theme = 'neutral' | 'butter';
+
+type Case = {
+ key: string;
+ story: string;
+ buttons: string[];
+ mode: Mode;
+ direction: Direction;
+ theme: Theme;
+ viewport: {width: number; height: number};
+ expected: {
+ count?: number;
+ side?: 'start' | 'end';
+ modal?: boolean;
+ role?: 'dialog' | 'alertdialog';
+ narrowCoverage?: 'reveal' | 'full';
+ motionDirection?: Direction;
+ paddingPx?: number;
+ };
+};
+
+const cases: Case[] = [];
+function addPair(
+ key: string,
+ story: string,
+ buttons: string[],
+ expected: Case['expected'],
+ options: Partial<Pick<Case, 'direction' | 'theme' | 'viewport'>> = {},
+) {
+ for (const mode of ['light', 'dark'] as const) {
+ cases.push({
+ key: `${key}-${mode}`,
+ story,
+ buttons,
+ mode,
+ direction: options.direction ?? 'ltr',
+ theme: options.theme ?? 'neutral',
+ viewport: options.viewport ?? WIDE,
+ expected,
+ });
+ }
+}
+
+addPair('modal-end', 'showcase', ['Open inspector'], {
+ side: 'end',
+ modal: true,
+ role: 'dialog',
+});
+addPair(
+ 'modal-end-custom-theme',
+ 'showcase',
+ ['Open inspector'],
+ {side: 'end', modal: true, role: 'dialog'},
+ {theme: 'butter'},
+);
+addPair('nonmodal-end', 'row-inspector', ['Open drawer'], {
+ side: 'end',
+ modal: false,
+ role: 'dialog',
+});
+addPair('start-ltr', 'sides', ['Open from start'], {
+ side: 'start',
+ modal: true,
+ role: 'dialog',
+});
+addPair(
+ 'end-ambient-rtl',
+ 'sides',
+ ['Open from end'],
+ {
+ side: 'end',
+ modal: true,
+ role: 'dialog',
+ motionDirection: 'rtl',
+ },
+ {direction: 'rtl'},
+);
+addPair(
+ 'start-self-rtl',
+ 'self-directed-rtl-start',
+ ['Open self-directed RTL start drawer'],
+ {side: 'start', modal: true, role: 'dialog', motionDirection: 'rtl'},
+);
+addPair(
+ 'end-self-rtl',
+ 'self-directed-rtl-end',
+ ['Open self-directed RTL end drawer'],
+ {side: 'end', modal: true, role: 'dialog', motionDirection: 'rtl'},
+);
+addPair(
+ 'nested-ltr-override',
+ 'nested-ltr-override',
+ ['Open nested LTR drawer'],
+ {side: 'end', modal: true, role: 'dialog', motionDirection: 'ltr'},
+ {direction: 'rtl'},
+);
+addPair(
+ 'mobile-reveal',
+ 'mobile-width',
+ ['56px reveal on mobile'],
+ {
+ side: 'end',
+ modal: true,
+ role: 'dialog',
+ narrowCoverage: 'reveal',
+ },
+ {viewport: NARROW},
+);
+addPair(
+ 'mobile-full',
+ 'mobile-width',
+ ['Full width on mobile'],
+ {side: 'end', modal: true, role: 'dialog', narrowCoverage: 'full'},
+ {viewport: NARROW},
+);
+addPair('purpose-form', 'purpose', ['form'], {
+ side: 'end',
+ modal: true,
+ role: 'dialog',
+});
+addPair('purpose-required', 'purpose', ['required'], {
+ side: 'end',
+ modal: true,
+ role: 'alertdialog',
+});
+addPair('themed-padding', 'themed-padding', ['Open themed drawer'], {
+ side: 'end',
+ modal: true,
+ role: 'dialog',
+ paddingPx: 24,
+});
+addPair('stacked', 'stacked-drawers', ['Open order', 'Open line item'], {
+ count: 2,
+ modal: false,
+ role: 'dialog',
+});
+
+test.describe.configure({mode: 'serial', retries: 0});
+let server: StaticServer;
+let checkoutSha: string;
+let storybookSha: string;
+
+function storyUrl(item: Case) {
+ return `${server.origin}/iframe.html?id=core-drawer--${item.story}&viewMode=story&globals=colorMode:${item.mode};astryxTheme:${item.theme};direction:${item.direction}`;
+}
+
+async function settle(page: Page) {
+ await holdMotionStill(page);
+ await page.evaluate(async () => document.fonts.ready);
+ await page.waitForTimeout(40);
+}
+
+async function readClosedTranslateX(page: Page): Promise<number | null> {
+ return page.locator('dialog.astryx-drawer').evaluate(dialog => {
+ const element = dialog as HTMLElement;
+ const previous = element.style.display;
+ element.style.display = 'flex';
+ const transform = getComputedStyle(element).transform;
+ element.style.display = previous;
+ if (transform === 'none') {
+ return null;
+ }
+ return new DOMMatrixReadOnly(transform).m41;
+ });
+}
+
+test.beforeAll(async () => {
+ fs.rmSync(OUTPUT, {recursive: true, force: true});
+ fs.mkdirSync(OUTPUT, {recursive: true});
+ checkoutSha = execFileSync('git', ['rev-parse', 'HEAD'], {
+ encoding: 'utf8',
+ }).trim();
+ const expected = process.env.ASTRYX_HEAD_SHA;
+ if (expected && expected !== checkoutSha) {
+ throw new Error(
+ `checkout ${checkoutSha} does not match expected head ${expected}`,
+ );
+ }
+ server = await serveStorybook(
+ process.env.ASTRYX_STORYBOOK_DIR ?? DEFAULT_STORYBOOK_DIR,
+ );
+ const response = await fetch(`${server.origin}/astryx-build-sha.txt`);
+ if (!response.ok) {
+ throw new Error(`Storybook build has no SHA stamp (${response.status})`);
+ }
+ storybookSha = (await response.text()).trim();
+ if (storybookSha !== checkoutSha) {
+ throw new Error(
+ `Storybook ${storybookSha} does not match checkout ${checkoutSha}`,
+ );
+ }
+});
+
+test.afterAll(async () => {
+ await server?.close();
+});
+
+for (const item of cases) {
+ test(item.key, async ({browser}) => {
+ const context = await browser.newContext({
+ viewport: item.viewport,
+ colorScheme: item.mode,
+ reducedMotion: 'reduce',
+ });
+ const page = await context.newPage();
+ const pageErrors: string[] = [];
+ page.on('pageerror', error => pageErrors.push(String(error)));
+ await page.goto(storyUrl(item), {waitUntil: 'load'});
+ await page.locator('#storybook-root').waitFor();
+ await settle(page);
+
+ const closedTranslateX = item.expected.motionDirection
+ ? await readClosedTranslateX(page)
+ : null;
+ if (item.expected.motionDirection) {
+ const ltrSign = item.expected.side === 'start' ? -1 : 1;
+ const directionSign = item.expected.motionDirection === 'rtl' ? -1 : 1;
+ expect(
+ (closedTranslateX ?? 0) * ltrSign * directionSign,
+ 'closed drawer moves toward its resolved logical edge',
+ ).toBeGreaterThan(0);
+ }
+
+ for (const label of item.buttons) {
+ await page.getByRole('button', {name: label, exact: true}).click();
+ await settle(page);
+ }
+
+ const drawers = page.locator('dialog.astryx-drawer:visible');
+ const expectedCount = item.expected.count ?? 1;
+ await expect(drawers).toHaveCount(expectedCount);
+ const drawer = drawers.last();
+ const box = await drawer.boundingBox();
+ if (box == null) {
+ throw new Error(`${item.key}: visible drawer has no geometry`);
+ }
+
+ const observed = await drawer.evaluate(element => {
+ const style = getComputedStyle(element);
+ const backdrop = getComputedStyle(element, '::backdrop');
+ const content = element.firstElementChild;
+ const contentStyle = content ? getComputedStyle(content) : null;
+ return {
+ role: element.getAttribute('role') ?? 'dialog',
+ name: element.getAttribute('aria-label'),
+ modal: element.getAttribute('aria-modal') === 'true',
+ side: element.getAttribute('data-side'),
+ direction: style.direction,
+ backgroundColor: style.backgroundColor,
+ color: style.color,
+ transform: style.transform,
+ backdropColor: backdrop.backgroundColor,
+ contentPaddingInlineStart: contentStyle?.paddingInlineStart ?? null,
+ contentPaddingInlineEnd: contentStyle?.paddingInlineEnd ?? null,
+ contentOverflowY: contentStyle?.overflowY ?? null,
+ };
+ });
+ const environment = await page.evaluate(() => ({
+ theme: document
+ .querySelector('[data-astryx-theme]')
+ ?.getAttribute('data-astryx-theme'),
+ mode: document.documentElement.getAttribute('data-theme'),
+ viewport: {width: innerWidth, height: innerHeight},
+ reducedMotion: matchMedia('(prefers-reduced-motion: reduce)').matches,
+ horizontalOverflow: document.documentElement.scrollWidth > innerWidth + 1,
+ fonts: document.fonts.status,
+ }));
+
+ expect(pageErrors).toEqual([]);
+ expect(environment.theme).toBe(item.theme);
+ expect(environment.mode).toBe(item.mode);
+ expect(environment.viewport).toEqual(item.viewport);
+ expect(environment.reducedMotion).toBe(true);
+ expect(environment.horizontalOverflow).toBe(false);
+ expect(environment.fonts).toBe('loaded');
+ expect(observed.side).toBe(item.expected.side ?? observed.side);
+ expect(observed.modal).toBe(item.expected.modal);
+ expect(observed.role).toBe(item.expected.role);
+ expect(observed.transform).toBe('matrix(1, 0, 0, 1, 0, 0)');
+ expect(observed.contentOverflowY).toBe('auto');
+
+ const expectedDirection = item.expected.motionDirection ?? item.direction;
+ expect(observed.direction).toBe(expectedDirection);
+ if (item.expected.side === 'start' && observed.direction === 'ltr') {
+ expect(box.x).toBeLessThanOrEqual(0.5);
+ }
+ if (item.expected.side === 'start' && observed.direction === 'rtl') {
+ expect(box.x + box.width).toBeGreaterThanOrEqual(
+ item.viewport.width - 0.5,
+ );
+ }
+ if (item.expected.side === 'end' && observed.direction === 'ltr') {
+ expect(box.x + box.width).toBeGreaterThanOrEqual(
+ item.viewport.width - 0.5,
+ );
+ }
+ if (item.expected.side === 'end' && observed.direction === 'rtl') {
+ expect(box.x).toBeLessThanOrEqual(0.5);
+ }
+ if (item.expected.narrowCoverage === 'reveal') {
+ expect(box.width).toBeCloseTo(item.viewport.width - 56, 0);
+ }
+ if (item.expected.narrowCoverage === 'full') {
+ expect(box.width).toBeCloseTo(item.viewport.width, 0);
+ }
+ if (item.expected.paddingPx != null) {
+ expect(Number.parseFloat(observed.contentPaddingInlineStart ?? '')).toBe(
+ item.expected.paddingPx,
+ );
+ expect(Number.parseFloat(observed.contentPaddingInlineEnd ?? '')).toBe(
+ item.expected.paddingPx,
+ );
+ }
+
+ const png = await page.screenshot({animations: 'disabled'});
+ expect(png.length).toBeGreaterThan(100);
+ const image = `${item.key}.png`;
+ const receipt = {
+ schemaVersion: 1,
+ expected: {
+ build: checkoutSha,
+ storyId: `core-drawer--${item.story}`,
+ mode: item.mode,
+ direction: item.direction,
+ theme: item.theme,
+ viewport: item.viewport,
+ ...item.expected,
+ },
+ observed: {
+ build: storybookSha,
+ drawerCount: expectedCount,
+ closedTranslateX,
+ geometry: box,
+ ...observed,
+ ...environment,
+ pageErrors,
+ },
+ image: {
+ file: image,
+ sha256: createHash('sha256').update(png).digest('hex'),
+ width: png.readUInt32BE(16),
+ height: png.readUInt32BE(20),
+ },
+ passed: true,
+ };
+ fs.writeFileSync(path.join(OUTPUT, image), png);
+ fs.writeFileSync(
+ path.join(OUTPUT, `${item.key}.sensors.json`),
+ `${JSON.stringify(receipt, null, 2)}\n`,
+ );
+ await context.close();
+ });
+}
+
+test('manifest is complete', async () => {
+ const receipts = fs
+ .readdirSync(OUTPUT)
+ .filter(file => file.endsWith('.sensors.json'));
+ expect(receipts).toHaveLength(cases.length);
+ const manifest = {
+ schemaVersion: 1,
+ component: 'core/Drawer',
+ build: checkoutSha,
+ frames: cases.map(item => ({
+ key: item.key,
+ image: `${item.key}.png`,
+ receipt: `${item.key}.sensors.json`,
+ })),
+ };
+ fs.writeFileSync(
+ path.join(OUTPUT, 'manifest.json'),
+ `${JSON.stringify(manifest, null, 2)}\n`,
+ );
+});