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

Manager: Update store.settings.lastTrackedStoryId #24115

Conversation

rashidshamloo
Copy link
Contributor

Closes #23723

What I did

In /code/ui/manager/src/components/layout/mobile.ts when navigating between SideBar (handleSideBarClick()) and Canvas (handleCanvasClick()), api.retrieveSelection() is used to get the current story id and if the returned id is falsy, the first story is selected as the current story.

api.retrieveSelection() returns store.getState().settings.lastTrackedStoryId, however, this lastTrackedStoryId is not set anywhere in the code, causing the returned value to always be null and thus when switching between SideBar and Canvas, always the first story is displayed.

When a story link is clicked on the SideBar, the api.selectStory() is called with the story id.

To fix the issue, I have updated the code/lib/manager-api/src/modules/stories.ts file and added the code to update the store.settings.lastTrackedStoryId with the current story id when api.selectStory() is called.

I have also added a test for this behavior to the code/lib/manager-api/src/tests/stories.test.ts file.

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

  1. Run the default sandbox
  2. Switch to the responsive/mobile mode in DevTools or browse on a mobile device
  3. Select / Click on a story on the sidebar
  4. Select / Click on the Canvas nav link (at the bottom)
  5. The same story should still be showing

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>

…lectStory() to enable keeping the current story active when navigating between sidebar and canvas on mobile
@JReinhold JReinhold self-assigned this Sep 11, 2023
@ndelangen
Copy link
Member

@JReinhold OI'll leave this with you to decide:
Does this change make sense in the upcoming layout change work?

@ndelangen ndelangen changed the title fix: added code to update store.settings.lastTrackedStoryId in api.se… Manager: Update store.settings.lastTrackedStoryId Sep 19, 2023
@valentinpalkovic valentinpalkovic removed their request for review October 2, 2023 12:42
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! 🙏

JReinhold

This comment was marked as duplicate.

@JReinhold JReinhold merged commit fd539a7 into storybookjs:next Oct 24, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants