mui / mui/material-ui

[material-ui][docs] Revise Transfer List docs

Open
#40,800 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Related page

https://mui.com/material-ui/react-transfer-list/

Kind of issue

Other

Issue description

Every other entry on the sidebar of the docs iterates and presents a component that may be used directly from Material UI. Meanwhile, transfer list is more a demo of something that could hypothetically be built if required, more suiting a how-to or placed within one of its constituent components.

Therefore, I suggest the Transfer List page is removed.

Context

Ideally, the documentation, when browsed, should immediately demonstrate the direct functionality of React MUI.

Decision

After the discussion below, and with https://github.com/mui/material-ui/issues/27579#issuecomment-894700501 in mind, the decision was to keep the Transfer List doc in its current place but revise it to add more details and context about how this isn't documented in the Material Design specs. It is a solid example of what's possible with Material UI composition.

We'll repurpose this issue for this work.

This decision section was edited by @DiegoAndai

Search keywords: Transfer List, shuttle

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 with the Transfer List documentation page at https://mui.com/material-ui/react-transfer-list/ and review the issue's decision section and prior discussion. Revise the page with additional details and context explaining that Transfer List is not documented in the Material Design specifications. Done means the page remains a useful example of Material UI composition while clearly providing that context.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.