search

mui / material-ui

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.
https://mui.com/material-ui/
MIT License
93.92k stars 32.27k forks source link

[material] `CssBaseline` flagged as deprecated without clear reason #29015

Closed JDDurrant closed 3 years ago

JDDurrant commented 3 years ago

This is a minor documentation issue. As far as I know, it can't currently affect a site's functionality. If I've raised this in the wrong section, please excuse me and let me know of my error.

Current Behavior 😯

When I adjust a theme's components.MuiCssBaseline value, my editor flags this key as deprecated, with the following message:

@deprecated - See CssBaseline.d.ts

This is due to the following piece of documentation:

https://github.com/mui-org/material-ui/blob/master/packages/mui-material/src/styles/components.d.ts#L132

When I check CssBaseline.d.ts, as instructed above, I see nothing about anything being deprecated.

I'm assuming that the file linked below is the correct file. If not, it might be a good idea for the @deprecated comment to specify the correct file's path.

https://github.com/mui-org/material-ui/blob/master/packages/mui-material/src/CssBaseline/CssBaseline.d.ts

Expected Behavior 🤔

If CssBaseline is deprecated, this should be documented in the component itself. Otherwise, it shouldn't be flagged as deprecated.

Steps to Reproduce 🕹

I don't think I can demonstrate a documentation issue with a codepen, so I haven't included one.

Steps:

  1. Check https://github.com/mui-org/material-ui/blob/master/packages/mui-material/src/styles/components.d.ts#L132
  2. See @deprecated
  3. Check https://github.com/mui-org/material-ui/blob/master/packages/mui-material/src/CssBaseline/CssBaseline.d.ts

Result: No @deprecated in actual component.

Context 🔦

Trying to apply MUI's custom scrollbars by following the otherwise excellent official documentation.

https://mui.com/components/css-baseline/#heading-scrollbars

I was able to apply the custom scrollbars, but I'm not sure how seriously the @deprecated message should be taken.

Your Environment 🌎

`npx @mui/envinfo` System: OS: Linux 5.4 Linux Mint 20.1 (Ulyssa) Binaries: Node: 14.18.0 - /usr/bin/node Yarn: 1.22.15 - /usr/bin/yarn npm: 6.14.15 - /usr/bin/npm Browsers: Chrome: Not Found Firefox: 93.0 npmPackages: @emotion/react: ^11.4.1 => 11.4.1 @emotion/styled: ^11.3.0 => 11.3.0 @mui/core: 5.0.0-alpha.50 @mui/icons-material: ^5.0.3 => 5.0.3 @mui/material: ^5.0.3 => 5.0.3 @mui/private-theming: 5.0.1 @mui/styled-engine: 5.0.1 @mui/system: ^5.0.3 => 5.0.3 @mui/types: 7.0.0 @mui/utils: ^5.0.1 => 5.0.1 @types/react: ^17.0.2 => 17.0.2 react: ^17.0.2 => 17.0.2 react-dom: ^17.0.2 => 17.0.2 typescript: ^4.2.2 => 4.2.2 ``` Don't forget to mention which browser you used. Output from `npx @mui/envinfo` goes here. ```

Note: I don't currently have Chrome installed on this system, but I'm currently using Brave; version: Version 1.30.87 Chromium: 94.0.4606.71 (Official Build) (64-bit)

eps1lon commented 3 years ago

Thanks for the report.

The JSDoc was added in https://github.com/mui-org/material-ui/pull/22293 but I can't find any mention of why it was added considering CSSBaseline.d.ts does not contain any explainer. @mnajdova Do you remember why you included the @deprecated annotation?

adamfitzgibbon commented 3 years ago

I went ahead and submitted a pull request removing the annotation. Feel free to close if you decide that it should indeed be deprecated!

mnajdova commented 3 years ago

It was related to https://github.com/mnajdova/material-ui/blob/d1df2a011600960ebbd8f4f1414999e3a3b9f77f/packages/material-ui/src/CssBaseline/CssBaseline.d.ts#L14. I think that I may heave just moved the deprecation on the wrong place at that time. We should remove it indeed.