FrontPastel/node_modules/@mui/material/Hidden/Hidden.d.ts

97 lines
2.5 KiB
TypeScript
Raw Normal View History

2024-04-17 13:55:11 +00:00
import * as React from 'react';
import { Breakpoint } from '@mui/system';
export interface HiddenProps {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* Specify which implementation to use. 'js' is the default, 'css' works better for
* server-side rendering.
* @default 'js'
*/
implementation?: 'js' | 'css';
/**
* 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
*/
initialWidth?: Breakpoint;
/**
* If `true`, component is hidden on screens below (but not including) this size.
* @default false
*/
lgDown?: boolean;
/**
* If `true`, component is hidden on screens this size and above.
* @default false
*/
lgUp?: boolean;
/**
* If `true`, component is hidden on screens below (but not including) this size.
* @default false
*/
mdDown?: boolean;
/**
* If `true`, component is hidden on screens this size and above.
* @default false
*/
mdUp?: boolean;
/**
* Hide the given breakpoint(s).
*/
only?: Breakpoint | Breakpoint[];
/**
* If `true`, component is hidden on screens below (but not including) this size.
* @default false
*/
smDown?: boolean;
/**
* If `true`, component is hidden on screens this size and above.
* @default false
*/
smUp?: boolean;
/**
* If `true`, component is hidden on screens below (but not including) this size.
* @default false
*/
xlDown?: boolean;
/**
* If `true`, component is hidden on screens this size and above.
* @default false
*/
xlUp?: boolean;
/**
* If `true`, component is hidden on screens below (but not including) this size.
* @default false
*/
xsDown?: boolean;
/**
* If `true`, component is hidden on screens this size and above.
* @default false
*/
xsUp?: boolean;
}
/**
* Responsively hides children based on the selected implementation.
*
* Demos:
*
* - [Hidden](https://mui.com/material-ui/react-hidden/)
*
* API:
*
* - [Hidden API](https://mui.com/material-ui/api/hidden/)
*/
declare const Hidden: React.JSXElementConstructor<HiddenProps>;
export default Hidden;