mui / mui/material-ui

[RFC] [docs] Add Flexbox Examples using the Stack component in the docs

Open
#35,228 4 comments 0 reactions 1 assignee View on GitHub

@siriwatknp is already working on this.

Since Dec 6, 2022.

discussion RFC scope: all components
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

What's the problem? 🤔

If I read the mui system documentation about flexbox, I was expecting to see some examples of the Stack component because it's basically a Box that implements flex, right?
But there are only examples of flexbox implemented with Box.

What are the requirements? ❓

The Stack component should be represented in the Flexbox documentation.

What are our options? 💡
  1. Either rewrite the docs using Stack

OR (preferred):

  1. Add flexbox examples using Stack and show them first.
Proposed solution 🟢

As said before, I would like to see Stack represented in the docs. Seeing only Box being used might lead to people thinking this is the preferred way of flexbox.
BUT I can also see that the linked documentation is implemented using only Box, which might have been done for a valid reason.
Thats why I am asking for comments on this.

Resources and benchmarks 🔗

No response

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.