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

UI: Fix display=true warning in console #25951

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Feb 7, 2024

Closes #25946

What I did

Use a show prop instead of display, because display is a native HTML attribute that Emotion components will apparently pass down to the native div, however display=true is not valid and thus is shows a warning.

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

  1. Create a sandbox
  2. add a tab addon in .storybook/manager.tsx:
import React from 'react';
import { addons } from '@storybook/manager-api';
import { Addon_TypesEnum } from '@storybook/types';

addons.register('test-tab', () => {
  addons.add('test-tab', {
    title: 'Test Tab',
    type: Addon_TypesEnum.TAB,
    render: () => (<div>my tab</div>),
  });
})
  1. Start Storybook
  2. See that switching between Canvas and the tab still works
  3. See that the error is gone from the console.

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

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>

@ndelangen ndelangen merged commit b6425f5 into next Feb 7, 2024
69 of 80 checks passed
@ndelangen ndelangen deleted the jeppe/25946-bug-warning-received-true-for-a-non-boolean-attribute-display branch February 7, 2024 23:23
@github-actions github-actions bot mentioned this pull request Feb 7, 2024
17 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.

[Bug]: Warning: Received true for a non-boolean attribute display
2 participants