styleguidist/react-styleguidist

"Knobs" Coming/Feature Request?

Open

#327 opened on Feb 14, 2017

View on GitHub
 (24 comments) (5 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
help wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

Are there any plans to add a way for react-styleguidist to have more interactive style "knobs" or form elements for the component's prop types. This is something I've seen on many other pattern library generators (see examples below), and I was mainly wondering if this is something that is being planned for react-styleguidist? Or is it something you'd be open to having if I looked into building it/adding it in?

Some examples would be like:

Contributor guide

Research direction
Study how react styleguidist currently renders component examples and props tables. Look at how Storybook's addon knobs or Atellier implement interactive controls. Then design a similar system that integrates with the existing style guide. Start by exploring the examples rendering logic and considering a plugin or built in extension point.
Tech stack
typescriptreactnodejs
Domain
frontenddeveloper experience
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
ReactGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60