mui / mui/material-ui

[RFC][material] Add template and guides on how to build a component library on top of Material UI

Open
#37,952 1 comment 14 reactions 1 assignee View on GitHub

@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 🟢

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 🔗

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.