mui-x
mui-x copied to clipboard
mui
[docs] Apply style guide to Data Grid Accessibility page
Part of #5764
This PR revises the Data Grid Accessibility page, addressing style, grammar and a bit of copywriting. Not many big changes here other than capitalizing "Data Grid" whenever referring to the MUI X component itself rather than the concept of a grid—see https://github.com/mui/mui-x/issues/5764#issuecomment-1213536072.
These are the results for the performance tests:
| Test case | Unit | Min | Max | Median | Mean | σ |
|---|---|---|---|---|---|---|
| Filter 100k rows | ms | 332.2 | 634.7 | 531.3 | 478.56 | 120.384 |
| Sort 100k rows | ms | 574.8 | 1,202.6 | 792.4 | 842.84 | 202.375 |
| Select 100k rows | ms | 158.1 | 279 | 215 | 216.86 | 38.699 |
| Deselect 100k rows | ms | 117.8 | 388.7 | 214.3 | 226.86 | 88.674 |
Generated by :no_entry_sign: dangerJS against 324c4324c1eda551c4712fde7e1d60396f936791
@samuelsycamore what do you think about reducing a bit the ambition of this PR so we can merge it? We could only update the capitalization of the components in the headers and leave the other references of the components in the body of the page untouched.
Then, once we get feedback from @mbrookes we can normalize how we reference the components in the body, whatever this convention is. A quick benchmark:
a. https://getbootstrap.com/docs/5.2/components/modal/ lower cases b. https://chakra-ui.com/docs/components/alert-dialog/usage code blocks or lower cases, no capitalization references in the body. c. https://www.radix-ui.com/docs/primitives/components/dialog not very consistent, but it seems the majority is lower cases. d. https://mantine.dev/core/notification/ not super consistent but a majority of upper cases.
Which one feels better?
My main concern is that the capitalization inside the body of the page makes the content feel "heavy". It's not as heavy as over using the <code> blocks but it still interputs more the reading flow than no special treatment. In practice, the distinction of meaning between generic component and our component feels unnecessary.
I agree with lower case mid sentence, unless it's a specific reference to the React component name.
@oliviertassinari It feels inconsistent to me to only capitalize component names in headlines. If we aren't treating them like Proper Nouns in the body of the docs, then it looks odd to do so in the headlines. It should all be one way or the other.
Following up on discussions with the Core team and on Slack, I'm going to move forward with the capitalization of MUI X component names. With that in mind I think this is good to be merged.