-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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: Deprecate useThemeParameters #30111
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile
@@ -13,7 +16,17 @@ export function pluckThemeFromContext({ globals }: StoryContext): string { | |||
} | |||
|
|||
export function useThemeParameters(context: StoryContext): ThemeParameters { | |||
return context.parameters[PARAM_KEY] || DEFAULT_THEME_PARAMETERS; | |||
if (!context) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: checking for !context seems incorrect - context should always be provided in valid usage
` | ||
); | ||
|
||
return useParameter<ThemeParameters>(PARAM_KEY, DEFAULT_THEME_PARAMETERS) as ThemeParameters; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: casting to ThemeParameters may hide type errors - consider using type guards instead
View your CI Pipeline Execution ↗ for commit 1ded935.
☁️ Nx Cloud last updated this comment at |
191ca46
to
1ded935
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs are good; thanks!
(The rest seems good to me, too, fwiw.)
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/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>
Greptile Summary
Here's my concise review of the changes:
Deprecates the useThemeParameters hook in favor of direct context access for theme parameters in the Storybook addon-themes package, improving code maintainability.
code/addons/themes/docs/api.md
with migration instructionscode/addons/themes/src/decorators/helpers.ts
to handle deprecated hook usage with warningThe changes are focused on removing an unnecessary abstraction layer while maintaining backward compatibility through proper deprecation notices.