Skip to content

Checklist: Fix contrast on dark mode and wait for checklist widget to load in stories #33121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ghengeveld merged 5 commits into from
Nov 21, 2025
Merged

Checklist: Fix contrast on dark mode and wait for checklist widget to load in stories #33121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72504c9
Wait for checklist widget to load
ghengeveld Nov 21, 2025
cd9c493
Fix narrow story
ghengeveld Nov 21, 2025
12f8d5a
Wait for expand animation
ghengeveld Nov 21, 2025
d74f04b
Fix bullet contrast
ghengeveld Nov 21, 2025
e07f0bc
Fix checklist contrast on dark mode
ghengeveld Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion code/core/src/manager/components/sidebar/ChecklistWidget.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export const ChecklistWidget = () => {

return (
<CollapsibleWithMargin collapsed={!hasItems || !loaded}>
<HoverCard outlineAnimation="rainbow">
<HoverCard id="storybook-checklist-widget" outlineAnimation="rainbow">

@valentinpalkovic valentinpalkovic Nov 21, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the ID is purely for testing purposes, we should prefer to use something like data-test-id instead. For the future

<Collapsible
collapsed={!hasItems}
disabled={!hasItems}
Expand Down
33 changes: 28 additions & 5 deletions code/core/src/manager/components/sidebar/Sidebar.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { Meta, StoryObj } from '@storybook/react-vite';

import type { IndexHash } from 'storybook/manager-api';
import { ManagerContext } from 'storybook/manager-api';
import { expect, fn, userEvent, within } from 'storybook/test';
import { expect, fn, userEvent, waitFor, within } from 'storybook/test';

import { initialState } from '../../../shared/checklist-store/checklistData.state';
import {
Expand Down Expand Up @@ -182,7 +182,18 @@ const refsEmpty = {
},
};

export const Simple: Story = {};
const waitForChecklistWidget = async () => {
await waitFor(
() =>
expect(document.getElementById('storybook-checklist-widget')?.checkVisibility()).toBe(true),
{ timeout: 5000 }
);
await wait(300); // wait for expand animation
};

export const Simple: Story = {
play: waitForChecklistWidget,
Comment thread
ghengeveld marked this conversation as resolved.
};

export const SimpleInProduction: Story = {
args: {
Expand All @@ -200,6 +211,7 @@ export const SimpleInProduction: Story = {
export const Mobile: Story = {
decorators: [mobileLayoutDecorator],
globals: { sb_theme: 'light', viewport: { value: 'mobile1' } },
play: waitForChecklistWidget,
};

export const Loading: Story = {
Expand All @@ -219,12 +231,14 @@ export const Empty: Story = {
args: {
index: {},
},
play: waitForChecklistWidget,
};

export const EmptyMobile: Story = {
args: Empty.args,
decorators: [mobileLayoutDecorator],
globals: { sb_theme: 'light', viewport: { value: 'mobile1' } },
play: waitForChecklistWidget,
};

export const EmptyIndex: Story = {
Expand All @@ -235,18 +249,21 @@ export const EmptyIndex: Story = {
v: 6,
},
},
play: waitForChecklistWidget,
};

export const IndexError: Story = {
args: {
indexError,
},
play: waitForChecklistWidget,
};

export const WithRefs: Story = {
args: {
refs,
},
play: waitForChecklistWidget,
};

export const WithRefsNarrow: Story = {
Expand All @@ -264,7 +281,7 @@ export const WithRefsNarrow: Story = {
narrow: {
name: 'narrow',
styles: {
width: '400px',
width: '230px',
height: '800px',
},
},
Expand All @@ -273,7 +290,7 @@ export const WithRefsNarrow: Story = {
chromatic: {
modes: {
narrow: {
viewport: 400,
viewport: 230,
},
},
},
Expand All @@ -283,12 +300,14 @@ export const WithRefsNarrow: Story = {
value: 'narrow',
},
},
play: waitForChecklistWidget,
};

export const WithRefsMobile: Story = {
args: WithRefs.args,
decorators: [mobileLayoutDecorator],
globals: { sb_theme: 'light', viewport: { value: 'mobile1' } },
play: waitForChecklistWidget,
};

export const LoadingWithRefs: Story = {
Expand Down Expand Up @@ -316,6 +335,7 @@ export const WithRefEmpty: Story = {
...Empty.args,
refs: refsEmpty,
},
play: waitForChecklistWidget,
};

export const StatusesCollapsed: Story = {
Expand Down Expand Up @@ -349,6 +369,7 @@ export const StatusesCollapsed: Story = {
return acc;
}, {} as StatusesByStoryIdAndTypeId),
},
play: waitForChecklistWidget,
};

export const StatusesOpen: Story = {
Expand Down Expand Up @@ -380,6 +401,7 @@ export const StatusesOpen: Story = {
} satisfies StatusesByStoryIdAndTypeId;
}, {} as StatusesByStoryIdAndTypeId),
},
play: waitForChecklistWidget,
};

export const Searching: Story = {
Expand All @@ -394,7 +416,7 @@ export const Searching: Story = {
),
],
play: async ({ canvasElement, step }) => {
await step('wait 2000ms', () => wait(2000));
await waitForChecklistWidget();
const canvas = await within(canvasElement);
const search = await canvas.findByPlaceholderText('Find components');
userEvent.clear(search);
Expand Down Expand Up @@ -473,6 +495,7 @@ export const Scrolled: Story = {
);
},
play: async ({ canvasElement, step }) => {
await waitForChecklistWidget();
const canvas = await within(canvasElement);
const scrollable = await canvasElement.querySelector('[data-radix-scroll-area-viewport]');
await step('expand component', async () => {
Expand Down
10 changes: 5 additions & 5 deletions code/core/src/manager/settings/Checklist/Checklist.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const Sections = styled.ol(({ theme }) => ({

'& > li': {
background: theme.background.content,
border: `1px solid ${theme.color.border}`,
border: `1px solid ${theme.base === 'dark' ? theme.color.darker : theme.color.border}`,
borderRadius: 8,
},
}));
Expand All @@ -47,7 +47,7 @@ const Items = styled.ol(({ theme }) => ({
padding: 0,

'& > li:not(:last-child)': {
boxShadow: `inset 0 -1px 0 ${theme.color.border}`,
boxShadow: `inset 0 -1px 0 ${theme.base === 'dark' ? theme.color.darker : theme.color.border}`,
},

'& > li:last-child': {
Expand Down Expand Up @@ -159,7 +159,7 @@ const ItemContent = styled.div(({ theme }) => ({
listStyleType: 'disc',

'li::marker': {
color: theme.color.medium,
color: theme.color.mediumdark,
},
},
}));
Expand All @@ -170,9 +170,9 @@ const StatusIcon = styled.div(({ theme }) => ({
minHeight: 16,
minWidth: 16,
margin: 0,
background: theme.background.app,
background: theme.base === 'dark' ? theme.color.darkest : theme.background.app,
borderRadius: 9,
outline: `1px solid ${theme.color.border}`,
outline: `1px solid ${theme.base === 'dark' ? theme.color.darker : theme.color.border}`,
outlineOffset: -1,
}));
const Checked = styled(StatusPassIcon)<{ 'data-visible'?: boolean }>(
Expand Down