Skip to content
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.

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

Addon-themes: Fix switcher initialization after first start #26353

Merged
merged 2 commits into from
Mar 7, 2024

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Mar 6, 2024

Closes #

What I did

I have fixed an issue where the theme switcher doesn't appeared at the first start of Storybook. After reloading the page, the theme switcher was in place, though.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a Next.js Typescript sandbox
  2. Add @storybook/addon-themes addon and install @mui/material, @emotion/reset, @emotion/react, @emotion/styled
  3. Adjust .storybook/preview.ts like so:
import type { Preview, ReactRenderer } from '@storybook/react';
import { withThemeFromJSXProvider } from '@storybook/addon-themes';
import { CssBaseline, ThemeProvider } from '@mui/material';
import { Roboto, Inika } from 'next/font/google';
import { createTheme } from '@mui/material/styles';

const roboto = Roboto({
  weight: ['300', '400', '500', '700'],
  subsets: ['latin'],
  display: 'swap',
});

const inika = Inika({
  weight: ['400', '700'],
  subsets: ['latin'],
  display: 'swap',
});

export const themeRoboto = createTheme({
  typography: {
    fontFamily: roboto.style.fontFamily,
  },
});

export const themeInika = createTheme({
  typography: {
    fontFamily: inika.style.fontFamily,
  },
  palette: {
    mode: 'dark',
  },
});


const preview: Preview = {
  parameters: {
    controls: {
      matchers: {
        color: /(background|color)$/i,
        date: /Date$/i,
      },
    },
  },

  decorators: [
      withThemeFromJSXProvider<ReactRenderer>({
        themes: {
          light: themeRoboto,
          dark: themeInika,
        },
        defaultTheme: 'light',
        Provider: ThemeProvider,
        GlobalStyles: CssBaseline,
      }),
    ],
};

export default preview;
  1. Open Storybook and a Story and make sure the theme switcher at the top is initialized and visible

Note: Currently, switching the theme doesn't have any effect on Docs pages (I'll investigate whether this is a newly introduced bug or whether it was never working there).
-->

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link

nx-cloud bot commented Mar 6, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4e0b97f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic marked this pull request as ready for review March 6, 2024 15:10
…book startup

Co-authored-by: Norbert de Langen <ndelangen@me.com>
@valentinpalkovic valentinpalkovic force-pushed the valentin/addon-themes-fix-initial-start branch from f6bdd9d to 4e0b97f Compare March 6, 2024 15:11
@valentinpalkovic valentinpalkovic merged commit 6ffa140 into next Mar 7, 2024
55 of 57 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/addon-themes-fix-initial-start branch March 7, 2024 07:56
@github-actions github-actions bot mentioned this pull request Mar 7, 2024
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant