JSMike commented 2 days ago

Currently there's a bug in the composed storybook version picker where the currently selected version has the word 'check' in front of it instead of a check icon.

https://github.com/storybookjs/storybook/blob/v8.3.3/code/core/src/manager/components/sidebar/RefIndicator.tsx#L219 https://github.com/storybookjs/storybook/blob/v8.3.3/code/core/src/components/components/tooltip/TooltipLinkList.tsx#L54 https://github.com/storybookjs/storybook/blob/v8.3.3/code/core/src/components/components/tooltip/TooltipLinkList.tsx#L41 https://github.com/storybookjs/storybook/blob/v8.3.3/code/core/src/components/components/tooltip/ListItem.tsx#L177 https://github.com/storybookjs/storybook/blob/v8.3.3/code/core/src/components/components/tooltip/ListItem.tsx#L206

What I did

Fix bug in refIndicator where reactNode is expected but string is passed. Import CheckIcon from @storybook/icons and replace string 'check' with CheckIcon.

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

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

Create a sandbox: yarn task --task sandbox --template react-vite/default-ts

set up a composed storybook example (I've been struggling with this, will update PR when I have working steps)

Modify /sandbox/react-vite-default-ts/.storybook/main.ts:

Add key to exports:

refs: {  test: { title: 'test', url: '/'  } },

Update vite server config to enable CORS:

config.server = {
  ...
  cors: true
}

create file /sandbox/react-vite-default-ts/.storybook/middleware.js with the contents:

module.exports = (router) => {
  router.get('/metadata.json', (req, res) => res.json({ versions: { 'v0': '/', 'v1': '/v1', 'v2': '/v2' }}));
};

Run sandbox:

cd sandbox/react-vite-default-ts
yarn storybook

Open Storybook in your browser
Scroll to bottom of sidebar to see composed storybook
Select version picker dropdown for composed storybook. Expect to see checkmark instead of word 'check'.

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>_

nx-cloud[bot] commented 2 days ago

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2e5da996448abf0d56e447cb41c969291c612dc5. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

- [`nx run-many -t build --parallel=3`](https://cloud.nx.app/runs/9K5JpReKsF?utm_source=pull-request&utm_medium=comment)

Sent with 💌 from NxCloud.