Skip to content

PigmentHidden API

API reference docs for the React PigmentHidden component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import PigmentHidden from '@mui/material/PigmentHidden';
// or
import { PigmentHidden } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
childrennode-

The content of the component.

implementation'css'
| 'js'
'js'

Specify which implementation to use. 'js' is the default, 'css' works better for server-side rendering.

initialWidth'lg'
| 'md'
| 'sm'
| 'xl'
| 'xs'
-

You can use this prop when choosing the js implementation with server-side rendering.
As window.innerWidth is unavailable on the server, we default to rendering an empty component during the first mount. You might want to use a heuristic to approximate the screen width of the client browser screen width.
For instance, you could be using the user-agent or the client-hints. https://caniuse.com/#search=client%20hint

lgDownboolfalse

If true, component is hidden on screens below (but not including) this size.

lgUpboolfalse

If true, component is hidden on screens this size and above.

mdDownboolfalse

If true, component is hidden on screens below (but not including) this size.

mdUpboolfalse

If true, component is hidden on screens this size and above.

only'lg'
| 'md'
| 'sm'
| 'xl'
| 'xs'
| Array<'lg'
| 'md'
| 'sm'
| 'xl'
| 'xs'>
-

Hide the given breakpoint(s).

smDownboolfalse

If true, component is hidden on screens below (but not including) this size.

smUpboolfalse

If true, component is hidden on screens this size and above.

xlDownboolfalse

If true, component is hidden on screens below (but not including) this size.

xlUpboolfalse

If true, component is hidden on screens this size and above.

xsDownboolfalse

If true, component is hidden on screens below (but not including) this size.

xsUpboolfalse

If true, component is hidden on screens this size and above.

The component cannot hold a ref.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.