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

TITLE string const as fallback for meta.title default export #593

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lunelson
Copy link

@lunelson lunelson commented Jan 1, 2025

Since the default export of a non-primitive value breaks react-refresh functionality in Vite, this PR proposes an alternative for providing a Story title that is react-refresh compatible:

Instead of this:

export default { title: "My/Story/Path" }

Do this:

export const TITLE = "My/Story/Path"

Copy link

changeset-bot bot commented Jan 1, 2025

⚠️ No Changeset found

Latest commit: 5bda641

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tajo
Copy link
Owner

tajo commented Jan 3, 2025

Appreciate the effort but I am not a big fan of adding this:

  1. It's a completely new API that we would have to support forever.
  2. It conflicts with the existing APIs (what gets the precedence?)
  3. There are more things that go into export default like decorators, args and meta.
  4. The improvement of user experience is pretty small and you can already avoid export default if you really care about HMR in stories that much. Also you can always keep story files light and do most of the work in the downstream modules.

I wonder if we could fork https://github.com/facebook/react/tree/main/packages/react-refresh instead to keep HMR working for the current API?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants