Skip to content

Hidden API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Hidden from '@mui/material/Hidden';
// or
import { Hidden } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Responsively hides children based on the selected implementation.

Props

Props of the native component are also available.

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'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
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'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| Array<'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'>
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.