-
-
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
Docs: Add Parameters API reference #25489
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.
Great work @kylegach !! A few minor points
} | ||
``` | ||
|
||
#### `options.storySort` |
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.
Note: This is only valid in project annotations. It probably should not be a parameter, but we haven't changed it yet
docs/api/parameters.md
Outdated
|
||
<div class="aside"> | ||
|
||
ℹ️ Parameters are **merged**, so individual keys are always overwritten, never dropped. |
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.
Probably worth clarifying the merge semantics in detail here. Objects are deep-merged, but arrays are replaced.
So merging
{
a: 'a1',
nested: { b: 'b1' },
array: [1, 2]
}
With
{
a: 'a2',
nested: { c: 'c2' },
array: [3, 4]
}
would yield
{
a: 'a2',
nested: { b: 'b1', c: 'c2' },
array: [3, 4]
}
- Add API references for all essential addons - Consolidate related snippets
- Clarify that `options` can only be applied at project level - Make parameters merge semantics more clear
86d49fc
to
c4d3fc5
Compare
Contributes to (but does not close): #17243
What I did
See also: storybookjs/addon-kit#61
Checklist for Contributors
Testing
Manual testing
api-ref-parameters
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/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>