Skip to content

Hidden API

API documentation for the React Hidden component. Learn about the available props and the CSS API.

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, screens this size and down are hidden.
lgUpboolfalse
If true, screens this size and up are hidden.
mdDownboolfalse
If true, screens this size and down are hidden.
mdUpboolfalse
If true, screens this size and up are hidden.
only'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'
| Array<'xs'
| 'sm'
| 'md'
| 'lg'
| 'xl'>
Hide the given breakpoint(s).
smDownboolfalse
If true, screens this size and down are hidden.
smUpboolfalse
If true, screens this size and up are hidden.
xlDownboolfalse
If true, screens this size and down are hidden.
xlUpboolfalse
If true, screens this size and up are hidden.
xsDownboolfalse
If true, screens this size and down are hidden.
xsUpboolfalse
If true, screens this size and up are hidden.

The component cannot hold a ref.

Demos