storybookjs/storybook

Configurable raw object editor control

Open

#15,900 创建于 2021年8月23日

在 GitHub 查看
 (11 评论) (12 反应) (0 负责人)TypeScript (89,909 star) (10,058 fork)batch import
addon: controlscompatibility with other toolsfeature requesthelp wantedtriage:reviewed

描述

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

贡献者指南

技术栈
typescriptreact
领域
frontendtoolingdeveloper experiencetesting
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
ReactStorybookJavaScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.