processing / processing/p5.js-web-editor
Create a component library/style guide
Open
@andrewn is already working on this.
Since Jan 28, 2020.
Area: Code Quality
Area: Documentation
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 8
Description
Nature of issue?
- New feature request
New feature details:
When developing features for the Editor, it can be challenging to figure out if the UI widget you need already exists in the project. If a component exists already, then copying it can cause subtle inconsistencies.
It'd be great to have a style guide in the projects that displays available components, and the different states they can be in. This should make the Editor more consistent, help reduce bugs and make contributing easier.
Possible choices
Considerations
- Work with React
- Display "live" versions of the components so that changes to them are immediately visible
- Work with whatever CSS approach the project uses (see #1215)
- Easy to add new components
- Display the code required to use the component next to the rendered version
- Generate a static site so it can be viewed on the web (?)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.