mui / mui/material-ui

[joy-ui] Add Sidebar component

Open
#38,629 0 comments 25 reactions 1 assignee View on GitHub

@mnajdova is already working on this.

Since Aug 24, 2023.

on hold package: joy-ui scope: new proposal type: new feature waiting for 👍
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Duplicates
  • I have searched the existing issues
Latest version
  • I have tested the latest version
Summary 💡

In https://github.com/mui/material-ui/pull/38169 we started a discussion of adding a Sidebar (left navigation, permanent drawer) component. Although it can be built using CSS grid or flexbox relatively easy, the value of it is to bring consistency and great DX. In addition to this, the component is often used together with the Drawer component, depending on the screen size, for e.g. https://mui.com/material-ui/react-drawer/#responsive-drawer.

In terms of the name for the component we can choose from the following:

  • PermanentDrawer (following Material UI's nomenclature)
  • Sidebar (similar to Chakra UI, I also feel this is the most common used term describing this component)
  • Sidenav (indicating it is a navigation)
  • AppShell
Examples 🌈

Mantine - https://mantine.dev/core/app-shell/
Material UI - https://mui.com/material-ui/react-drawer/#permanent-drawer
Chakra UI (pro) - https://pro.chakra-ui.com/components/application/sidebars
Ant design - https://ant.design/components/layout#components-layout-demo-side

Motivation 🔦

Bringing consistency and feature parity with other react UI libraries.

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.