storybookjs/storybook

[Bug]: "useArgs" hook updates wrong story when rendered in "Stories" block

Open

#28333 opened on Jun 24, 2024

View on GitHub
 (3 comments) (9 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
bughelp wantedsev:S3

Description

Describe the bug

When writing a story for a controlled component, one should expect the useArgs hook to update the args being passed to the story it is being called in. However, when used inside a "Stories" block, it updates the page's primary story instead of itself. This isn't an issue when using a "Canvas" block or any other block that selects a specific story. I'm sure this could be user error but I don't see why there would then be a discrepancy between the functionality between the "Stories" block and an individual "Story" block.

Reproduction link

https://stackblitz.com/edit/github-n2sxrc?file=src%2Fstories%2FInput.tsx

Reproduction steps

  1. Go to the "Input" docs in Storybook.
  2. Attempt to edit one of the stories under the "Stories" header.
  3. Notice that value of top story is changing, instead of the story being edited.

System

Storybook Environment Info:

  System:
    OS: Linux 5.0 undefined
    CPU: (8) x64 Intel(R) Core(TM) i9-9880H CPU @ 2.30GHz
    Shell: 1.0 - /bin/jsh
  Binaries:
    Node: 18.20.3 - /usr/local/bin/node
    Yarn: 1.22.19 - /usr/local/bin/yarn
    npm: 10.2.3 - /usr/local/bin/npm <----- active
    pnpm: 8.15.6 - /usr/local/bin/pnpm

Additional context

No response

Contributor guide

Tech stack
typescriptreactnodejs
Domain
frontenddeveloper experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of StorybookUnderstanding of React hooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the `useArgs` hook implementation in Storybook (likely in `lib/api/src/lib/useArgs.ts` or similar). Compare behavior when used inside a `Stories` block vs a `Canvas` or `Story` block. The issue suggests that in the `Stories` block, the args are being applied to the primary story instead of the targeted story. Look at how the `Stories` block renders multiple stories and how it passes context to each story. Check if there is a missing story ID propagation in the `useArgs` hook when multiple stories are rendered. Review the reproduction link provided in the issue to understand the exact scenario. Consider if the fix involves ensuring that `useArgs` targets the correct story by its ID, especially when used in a block that renders multiple stories.