mui / mui/material-ui

[docs] Allow table of contents viewable on mobile

Open
#25,688 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Basically, add a button toggle that shows the current page's table of contents on mobile viewports. Currently, table of contents are hidden on mobile.

Examples 🌈

Here's an example I whipped up with CSS. There's no toggle button, but ideally, it could be a Fab button on the bottom right that toggles this menu.

Motivation 🔦

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.

Research direction

No files or tests are named in the issue. Start by locating the documentation page's current table-of-contents implementation and its mobile viewport behavior; done means a mobile user can toggle the current page's table of contents, with the expected placement and behavior agreed from the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.