Skip to content

Docs: Prevent JSON tree control from swallowing keyboard events when not in focus #31841

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

Open
wants to merge 5 commits into
base: next
Choose a base branch
from

Conversation

takashi-kasajima
Copy link

@takashi-kasajima takashi-kasajima commented Jun 23, 2025

Closes #31092

What I did

  • Updated JsonNodes to only apply the change by clicking the enter key if the form is focused

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!

  1. Run in the code directory by yarn storybook:ui
  2. Open Storybook in your browser
  3. Access the story ADDONS/docs/blocks/Controls/JsonNodes
  4. Try focusing the link says Confirm the link works by pressing enter key and confirm it opens a link -- this ensures the input with the value value doesn't block keyboard
image
  1. Press [+] button and open a form to add another prop to the object
image
  1. Focus on the link again and confirm it opens a link by pressing enter key
  2. Click on the function prop object and turn it to the edit mode
image
  1. Focus on the link again and confirm it opens a link by pressing enter key
  2. Confirm each input submits a new value by clicking enter if it's focused

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-storybook/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>

Greptile Summary

Fixed keyboard event handling in JSON tree editor to prevent Enter key from triggering updates when not focused on inputs, improving accessibility and form interactions.

  • Updated JsonNodes.tsx to only process Enter key events when form elements are explicitly focused
  • Added new test story JsonNodes.stories.tsx to validate keyboard navigation and link activation
  • Fixed issue where Enter key was being incorrectly captured by JSON tree editor, blocking link activation
  • Modified event handling in JsonAddValue, JsonFunctionValue, and JsonValue components
  • Improved keyboard accessibility by ensuring proper focus management for form controls

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

Comment on lines +4 to +5
title: 'Controls/JsonNodes',
tags: ['autodocs'],
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider moving story under 'Addons/Docs/Controls' to match standard Storybook hierarchy

@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Jun 23, 2025

Package Benchmarks

Commit: 4215288, ran on 25 June 2025 at 15:46:14 UTC

The following packages have significant changes to their size or dependencies:

storybook

Before After Difference
Dependency count 51 51 0
Self size 31.73 MB 31.72 MB 🎉 -14 KB 🎉
Dependency size 17.43 MB 17.43 MB 0 B
Bundle Size Analyzer Link Link

sb

Before After Difference
Dependency count 52 52 0
Self size 1 KB 1 KB 0 B
Dependency size 49.16 MB 49.15 MB 🎉 -14 KB 🎉
Bundle Size Analyzer Link Link

@storybook/cli

Before After Difference
Dependency count 218 218 0
Self size 582 KB 582 KB 0 B
Dependency size 94.81 MB 94.80 MB 🎉 -14 KB 🎉
Bundle Size Analyzer Link Link

@storybook/codemod

Before After Difference
Dependency count 187 187 0
Self size 31 KB 31 KB 0 B
Dependency size 78.91 MB 78.90 MB 🎉 -14 KB 🎉
Bundle Size Analyzer Link Link

@ghengeveld ghengeveld moved this to Empathy Queue (prioritized) in Core Team Projects Jun 23, 2025
@ghengeveld ghengeveld changed the title fix: submit JSON tree update when focused Docs: Prevent JSON tree control from swallowing keyboard events when not in focus Jun 25, 2025
Copy link

nx-cloud bot commented Jun 25, 2025

View your CI Pipeline Execution ↗ for commit 4215288.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 17s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-25 15:38:12 UTC

@ghengeveld ghengeveld added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 25, 2025
@ghengeveld ghengeveld moved this from Empathy Queue (prioritized) to In Progress in Core Team Projects Jun 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch ui
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

[Bug]: Object control swallows Enter presses in docs page outside of ArgsTable
4 participants