mui / mui/material-ui

[docs] Missing component name API section for components

Open
#20,556 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

internal scope: docs-infra
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

In #20434, a Component Name section was added to many components.

Unfortunately, the section seems to be missing for the following components:

  • ClickAwayListener
  • Fade
  • Grow
  • Hidden
  • MenuList
  • Modal
  • NoSsr
  • Popper
  • Portal
  • RadioGroup
  • RootRef
  • Slide
  • SwipeableDrawer
  • TextareaAutosize
  • TouchRipple
  • Zoom

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

Start by reviewing the Component Name section added in #20434 and the documentation pages for the listed components: ClickAwayListener, Fade, Grow, Hidden, MenuList, Modal, NoSsr, Popper, Portal, RadioGroup, RootRef, Slide, SwipeableDrawer, TextareaAutosize, TouchRipple, and Zoom. Add the missing sections consistently, then verify that each component page includes the expected API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.