storybookjs/storybook

Configurable raw object editor control

Open

#15,900 opened on Aug 23, 2021

View on GitHub
 (11 comments) (12 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
addon: controlscompatibility with other toolsfeature requesthelp wantedtriage:reviewed

Description

Is your feature request related to a problem? Please describe Controls addon for objects displays json using react-editable-json-tree. It is set to not use raw editor by default. This causes a bit of a problem for automated cypress tests as it is easier to interact with simple textarea than with json tree component.

Describe the solution you'd like We would like to have configurable object editor through argTypes, something like: control: { type: 'object', useRaw: true }

Describe alternatives you've considered I didn't found any alternative to this.

Are you able to assist to bring the feature to reality? maybe yes :)

Additional context image

Contributor guide

Tech stack
typescriptreact
Domain
frontendtoolingdeveloper experiencetesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactStorybookJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the Controls addon in the Storybook codebase, particularly the ObjectEditor component that relies on react editable json tree. The goal is to add a configurable `useRaw` prop to control objects, allowing a pure textarea instead of the tree editor. Modify the argTypes handling in the addon to pass this option. Check existing tests and comments in the issue for additional guidance.