Core: Support parameters.__id
and metaId
in indexers
#23656
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Works on #23457
What I did
IndexInput
:key
toexportName
metaId
, to optionally overwrite the automatic generation of meta id based on title. If this is passed by the indexer, it must also be set atmeta.id
to be picked up by the preview too.CsfFile.parse()
already does all of this.__id
, to optionally overwrite the automatic generation of the whole story id. If this is passed by the indexer, it must also be set atstory.parameters.__id
to be picked up by the preview too.story.parameters.__id
inCsfFile.parse()
. If this is set now, the story will pick that up as the its id, disregarding anything else.How to test
See new unit tests for
CsfFIle
, as well as the updated ones with theIndexInput
changes. I've also added some stories that tests the custom id, that should show up in Chromatic.Checklist
MIGRATION.MD
Maintainers
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
["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]
🦋 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>