UNPKG

@mui/base

Version:

MUI Base is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.

70 lines (68 loc) 2.48 kB
'use client'; import * as React from 'react'; import PropTypes from 'prop-types'; import { exactProp, unstable_useEnhancedEffect as useEnhancedEffect } from '@mui/utils'; /** * NoSsr purposely removes components from the subject of Server Side Rendering (SSR). * * This component can be useful in a variety of situations: * * * Escape hatch for broken dependencies not supporting SSR. * * Improve the time-to-first paint on the client by only rendering above the fold. * * Reduce the rendering time on the server. * * Under too heavy server load, you can turn on service degradation. * * Demos: * * - [No SSR](https://mui.com/base-ui/react-no-ssr/) * * API: * * - [NoSsr API](https://mui.com/base-ui/react-no-ssr/components-api/#no-ssr) */ function NoSsr(props) { const { children, defer = false, fallback = null } = props; const [mountedState, setMountedState] = React.useState(false); useEnhancedEffect(() => { if (!defer) { setMountedState(true); } }, [defer]); React.useEffect(() => { if (defer) { setMountedState(true); } }, [defer]); // TODO casting won't be needed at one point https://github.com/DefinitelyTyped/DefinitelyTyped/pull/65135 return mountedState ? children : fallback; } process.env.NODE_ENV !== "production" ? NoSsr.propTypes /* remove-proptypes */ = { // ┌────────────────────────────── Warning ──────────────────────────────┐ // │ These PropTypes are generated from the TypeScript type definitions. │ // │ To update them, edit the TypeScript types and run `pnpm proptypes`. │ // └─────────────────────────────────────────────────────────────────────┘ /** * You can wrap a node. */ children: PropTypes.node, /** * If `true`, the component will not only prevent server-side rendering. * It will also defer the rendering of the children into a different screen frame. * @default false */ defer: PropTypes.bool, /** * The fallback content to display. * @default null */ fallback: PropTypes.node } : void 0; if (process.env.NODE_ENV !== 'production') { // eslint-disable-next-line NoSsr['propTypes' + ''] = exactProp(NoSsr.propTypes); } export { NoSsr };