[RFC][material] Add template and guides on how to build a component library on top of Material UI
Open
@DiegoAndai is already working on this.
Since Jul 13, 2023.
RFC
scope: all components
waiting for 👍
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
What's the problem? 🤔
One use case for Material UI is to use it build a custom component library on top of it, but we don't have a template or a guide on how to do it.
What are the requirements? ❓
Provide a starting point for users that need to build a component library on top of Material UI.
What are our options? 💡
Alternative/additional options:
- Writing a blog post on how to set up a component library on top of Material UI
- Having one cross-product template/guide on which the user can decide between Base UI, Joy UI, and Material UI
Proposed solution 🟢
- Add a component library template that's ready to start building upon
- The template will go in the examples directory: https://github.com/mui/material-ui/tree/master/examples
- Add guides on how to develop and deploy a component library using the template
The configuration and setup for the template are yet to be defined, that's the main purpose of this RFC: What would you like this template to look like. Of course, different configurations can be added in the future but the goal of this issue is to provide at least one.
Resources and benchmarks 🔗
- Base UI's WIP component library template: https://github.com/michaldudak/rebased-design-system
- Bit's blog: "Building a Composable Material UI Design System with Bit"
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.