Skip to content

chore: add Storybook tool for dark mode #1721

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
merged 3 commits into from
Feb 27, 2024
Merged

chore: add Storybook tool for dark mode #1721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dee62a
Add storybook dark mode tool
jzempel Feb 26, 2024
22af1ba
Improve `theme` prop type
jzempel Feb 26, 2024
8820b9e
Fix tsc
jzempel Feb 26, 2024
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 .storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const PACKAGE_NAMES = readdirSync(path.resolve(__dirname, '../packages')).filter
);

module.exports = {
stories: ['../packages/*/demo/**/*.stories.@(js|jsx|ts|tsx|mdx)'],
stories: [`../packages/${process.env.PACKAGE || '*'}/demo/**/*.stories.@(js|jsx|ts|tsx|mdx)`],
Copy link
Member Author

@jzempel jzempel Feb 26, 2024

Choose a reason for hiding this comment

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

provides an efficiency mechanism for focused package development, i.e. PACKAGE=accordions npm start only compiles accordions stories.

Copy link
Contributor

@geotrev geotrev Feb 26, 2024

Choose a reason for hiding this comment

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

🤯 the update we needed

staticDirs: ['./static'],
addons: ['@storybook/addon-essentials', '@storybook/addon-a11y', '@storybook/addon-designs'],
framework: {
Expand Down
27 changes: 19 additions & 8 deletions .storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@
import React, { StrictMode } from 'react';
import styled, { createGlobalStyle } from 'styled-components';
import { create } from '@storybook/theming/create';
import { ThemeProvider, DEFAULT_THEME } from '../packages/theming/src';
import { ThemeProvider, DEFAULT_THEME, getColor } from '../packages/theming/src';

export const parameters = {
actions: { argTypesRegex: '^on[A-Z].*' },
backgrounds: {
disable: true,
grid: { disable: true }
grid: { disable: true },
values: [
{ name: 'light', value: DEFAULT_THEME.colors.background },
{ name: 'dark', value: DEFAULT_THEME.colors.foreground }
]
},
controls: {
hideNoControlsWarning: true,
Expand Down Expand Up @@ -50,11 +53,19 @@ const withThemeProvider = (story, context) => {
document.querySelector('link[href$="bedrock/dist/index.css"]').setAttribute('disabled', true);
}

const theme = {
...DEFAULT_THEME,
colors: { ...DEFAULT_THEME.colors, primaryHue: context.globals.primaryHue },
rtl
};
const colors = { ...DEFAULT_THEME.colors, primaryHue: context.globals.primaryHue };

if (
context.globals.backgrounds && context.globals.backgrounds.value !== 'transparent'
? context.globals.backgrounds.value === DEFAULT_THEME.colors.foreground
: context.parameters.backgrounds.default === 'dark'
) {
colors.base = 'dark';
colors.background = getColor('neutralHue', 900, DEFAULT_THEME);
colors.foreground = getColor('neutralHue', 200, DEFAULT_THEME);
}

const theme = { ...DEFAULT_THEME, colors, rtl };

return (
<ThemeProvider theme={theme}>
Expand Down
4 changes: 2 additions & 2 deletions packages/theming/src/elements/ThemeProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import React, { PropsWithChildren, useRef } from 'react';
import { ThemeProvider as StyledThemeProvider } from 'styled-components';
import { useFocusVisible } from '@zendeskgarden/container-focusvisible';
import { getControlledValue } from '@zendeskgarden/container-utilities';
import { IThemeProviderProps } from '../types';
import { IGardenTheme, IThemeProviderProps } from '../types';
import DEFAULT_THEME from './theme';
import { useDocument } from '../utils/useDocument';

Expand All @@ -20,7 +20,7 @@ export const ThemeProvider = ({
...other
}: PropsWithChildren<IThemeProviderProps>) => {
const scopeRef = useRef<HTMLDivElement>(null);
const relativeDocument = useDocument(theme);
const relativeDocument = useDocument(theme as IGardenTheme);
const controlledScopeRef =
focusVisibleRef === null
? React.createRef<HTMLElement>()
Expand Down
6 changes: 3 additions & 3 deletions packages/theming/src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* found at http://www.apache.org/licenses/LICENSE-2.0.
*/

import { ThemeProps } from 'styled-components';
import { ThemeProviderProps } from 'styled-components';

export const ARROW_POSITION = [
'top',
Expand Down Expand Up @@ -146,13 +146,13 @@ export interface IGardenTheme {
palette: Record<string, Hue>;
}

export interface IThemeProviderProps extends Partial<ThemeProps<IGardenTheme>> {
export interface IThemeProviderProps extends Partial<ThemeProviderProps<IGardenTheme>> {
/**
* Provides values for component styling. See styled-components
* [`ThemeProvider`](https://styled-components.com/docs/api#themeprovider)
* for details.
*/
theme?: IGardenTheme;
theme?: IGardenTheme | ((theme: IGardenTheme) => IGardenTheme);
/**
* Provides a reference to the DOM node used to scope a `:focus-visible`
* polyfill. If left `undefined`, a scoping `<div>` will be rendered.
Expand Down