[docs] Move SelectUnstyled docs to the Base space #31816

michaldudak · 2022-03-15T13:26:07Z

Moved the SelectUnstyled, MultiSelectUnstyled, OptionUnstyled, and OptionGroupUnstyled docs to the Base space.

Preview - https://deploy-preview-31816--material-ui.netlify.app/base/react-select/

mui-bot · 2022-03-15T13:28:15Z

Generated by 🚫 dangerJS against 63e2f72

siriwatknp · 2022-03-15T13:31:59Z

@michaldudak You might have to do the same with https://github.com/mui/material-ui/pull/31417/files#diff-0f62cd80e39c6c4c31bfbd4d836a0e888559f35b05d9d1d833db0e815d94d6f3 so that the yarn docs:api works correctly.

siriwatknp · 2022-03-15T16:19:36Z

2 points for discussion:

Should all the headings have the same level (currently most of the demos are nested in "The SelectUnstyled component" which affects the search to be in the lower rank)?

I think the heading should contain only keyword. For example:

"The SelectUnstyled component" should be just "Select unstyled"
"Grouping" should be "Grouping options" (to be more explicit)
"Customizing the selected value appearance" should be just "Selected value appearance"

docs/data/base/components/select/select.md

Co-authored-by: Sam Sycamore <[email protected]> Co-authored-by: Siriwat K <[email protected]>

michaldudak · 2022-03-16T11:06:42Z

Should all the headings have the same level

@siriwatknp It doesn't feel right. The "Basic usage", "Controlled select", etc. are about the unstyled component, so to me, it makes sense to have them nested.

I think the heading should contain only keyword.

All right, no problem.

Co-authored-by: Sam Sycamore <[email protected]>

mnajdova · 2022-03-17T09:00:54Z

docs/data/base/components/select/select.md

+The `SelectUnstyled` component accepts generic props.
+Due to TypeScript limitations, this may cause unexpected behavior when wrapping the component in `forwardRef` (or other higher-order components).
+In such cases, the generic argument will be defaulted to `unknown` and type suggestions will be incomplete.
+To avoid this, you can manually cast the resulting component to the correct type, as shown in the demo above.


How about we show a short code snippet of this instead of asking developers to open the previous demo?

mnajdova · 2022-03-17T10:23:04Z

docs/data/base/components/select/select.md

+
+{{"demo": "UnstyledSelectMultiple.js", "defaultCodeOpen": false}}
+
+## The useSelect hook


Suggested change

## The useSelect hook

## The `useSelect` hook

?

I think we want to avoid back ticks in headers. At least, I think that's the way it already is elsewhere in the docs. But maybe we don't have a consistent pattern established.

docs/data/base/components/select/select.md

Co-authored-by: Marija Najdova <[email protected]>

docs/data/base/components/select/select.md

mnajdova

Two last comments from my side, the rest looks good

mnajdova · 2022-03-21T08:46:06Z

docs/data/base/components/select/select.md

+
+# Select
+
+<p class="description">The SelectUnstyled and MultiSelectUnstyled components let you create menus of options for users to choose from.</p>


Suggested change

<p class="description">The SelectUnstyled and MultiSelectUnstyled components let you create menus of options for users to choose from.</p>

<p class="description">The select components allow developers to create menus of options for users to choose from.</p>

We are already mentioning below the name of the components, so it's redundant. Also, to keep consistent with other docs pages, I have rephrased a bit.

According to #31850 (comment), "allow" is not the best word to use here. How about "The select components let you create..."

Also, I'm not sure about the word "menus" here. I understand it may be used in a broader sense than "a menu component", but I'm afraid it could confuse developers and make them wonder which component should be used to actually implement a menu control.

Ok, then we need to revisit all unstyled docs in the end and update this, some may have been merged already if I am not mistaken.

For the menus, I had the same thought, I was thinking list of options may be better. Similar terminology is used in wai aria too - https://www.w3.org/TR/wai-aria-practices-1.1/examples/listbox/listbox-collapsible.html (fi this is the equivalent)

docs/data/base/components/select/select.md

Co-authored-by: Sam Sycamore <[email protected]> Co-authored-by: Marija Najdova <[email protected]>

michaldudak added 2 commits March 15, 2022 14:14

Move SelectUnstyled docs to the Base space

760c44f

yarn docs:api

a9d24c2

michaldudak added the docs Improvements or additions to the documentation label Mar 15, 2022

michaldudak requested review from mnajdova, siriwatknp and samuelsycamore March 15, 2022 13:26

Fix URL generation

3aee33f

michaldudak mentioned this pull request Mar 15, 2022

[docs] Move unstyled components' docs to the Base space #31414

Closed

17 tasks

michaldudak marked this pull request as ready for review March 15, 2022 13:49

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

siriwatknp reviewed Mar 15, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

samuelsycamore reviewed Mar 16, 2022

View reviewed changes

Sam's suggestions

af340b3

Co-authored-by: Sam Sycamore <[email protected]> Co-authored-by: Siriwat K <[email protected]>

Update docs

926efaf

michaldudak force-pushed the select-docs branch from bc4a3a9 to 926efaf Compare March 16, 2022 11:32

michaldudak and others added 2 commits March 16, 2022 13:14

Do not show demo previews

7137515

Apply suggestions from code review

8a2a7c2

Co-authored-by: Sam Sycamore <[email protected]>

mnajdova reviewed Mar 17, 2022

View reviewed changes

Show how to typecast the higher order component

2ef335d

mnajdova reviewed Mar 17, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

Update docs/data/base/components/select/select.md

672e72c

Co-authored-by: Marija Najdova <[email protected]>

samuelsycamore reviewed Mar 18, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

samuelsycamore reviewed Mar 18, 2022

View reviewed changes

docs/data/base/components/select/select.md Outdated Show resolved Hide resolved

mnajdova reviewed Mar 21, 2022

View reviewed changes

michaldudak and others added 2 commits March 21, 2022 11:20

Apply suggestions from code review

2a938ef

Co-authored-by: Sam Sycamore <[email protected]> Co-authored-by: Marija Najdova <[email protected]>

Use different words

0318b72

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 21, 2022

Merge remote-tracking branch 'upstream/master' into docs/select

f35fa65

github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Mar 22, 2022

michaldudak added 2 commits March 25, 2022 11:52

Merge remote-tracking branch 'upstream/master' into docs/select

64af5c1

Merge remote-tracking branch 'upstream/master' into docs/select

3c25930

github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Mar 25, 2022

mnajdova approved these changes Mar 29, 2022

View reviewed changes

Merge branch 'master' into docs/select

a9ee572

github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels Mar 29, 2022

Merge remote-tracking branch 'upstream/master' into docs/select

63e2f72

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 29, 2022

michaldudak merged commit 3905693 into mui:master Mar 29, 2022

michaldudak deleted the select-docs branch March 29, 2022 11:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Move SelectUnstyled docs to the Base space #31816

[docs] Move SelectUnstyled docs to the Base space #31816

michaldudak commented Mar 15, 2022 •

edited by mnajdova

Loading

mui-bot commented Mar 15, 2022 •

edited

Loading

siriwatknp commented Mar 15, 2022

siriwatknp commented Mar 15, 2022 •

edited

Loading

michaldudak commented Mar 16, 2022 •

edited

Loading

mnajdova Mar 17, 2022

samuelsycamore Mar 17, 2022

mnajdova Mar 17, 2022

samuelsycamore Mar 17, 2022

mnajdova left a comment

mnajdova Mar 21, 2022

michaldudak Mar 21, 2022

mnajdova Mar 21, 2022


		{{"demo": "UnstyledSelectMultiple.js", "defaultCodeOpen": false}}

		## The useSelect hook


		# Select

		<p class="description">The SelectUnstyled and MultiSelectUnstyled components let you create menus of options for users to choose from.</p>

	<p class="description">The SelectUnstyled and MultiSelectUnstyled components let you create menus of options for users to choose from.</p>
	<p class="description">The select components allow developers to create menus of options for users to choose from.</p>

[docs] Move SelectUnstyled docs to the Base space #31816

[docs] Move SelectUnstyled docs to the Base space #31816

Conversation

michaldudak commented Mar 15, 2022 • edited by mnajdova Loading

mui-bot commented Mar 15, 2022 • edited Loading

siriwatknp commented Mar 15, 2022

siriwatknp commented Mar 15, 2022 • edited Loading

michaldudak commented Mar 16, 2022 • edited Loading

mnajdova Mar 17, 2022

Choose a reason for hiding this comment

samuelsycamore Mar 17, 2022

Choose a reason for hiding this comment

mnajdova Mar 17, 2022

Choose a reason for hiding this comment

samuelsycamore Mar 17, 2022

Choose a reason for hiding this comment

mnajdova left a comment

Choose a reason for hiding this comment

mnajdova Mar 21, 2022

Choose a reason for hiding this comment

michaldudak Mar 21, 2022

Choose a reason for hiding this comment

mnajdova Mar 21, 2022

Choose a reason for hiding this comment

michaldudak commented Mar 15, 2022 •

edited by mnajdova

Loading

mui-bot commented Mar 15, 2022 •

edited

Loading

siriwatknp commented Mar 15, 2022 •

edited

Loading

michaldudak commented Mar 16, 2022 •

edited

Loading