UNPKG

@mui/material

Version:

React components that implement Google's Material Design.

121 lines (112 loc) 3.84 kB
import * as React from 'react'; import { SxProps } from '@mui/system'; import { FadeProps } from '../Fade'; import { TransitionProps } from '../transitions/transition'; import { Theme } from '../styles'; import { BackdropClasses } from './backdropClasses'; import { OverridableComponent, OverrideProps } from '../OverridableComponent'; export interface BackdropComponentsPropsOverrides {} export interface BackdropTypeMap<P = {}, D extends React.ElementType = 'div'> { props: P & Partial<Omit<FadeProps, 'children'>> & { /** * The content of the component. */ children?: React.ReactNode; /** * The components used for each slot inside. * * This prop is an alias for the `slots` prop. * It's recommended to use the `slots` prop instead. * * @default {} */ components?: { Root?: React.ElementType; }; /** * The extra props for the slot components. * You can override the existing props or add new ones. * * This prop is an alias for the `slotProps` prop. * It's recommended to use the `slotProps` prop instead, as `componentsProps` will be deprecated in the future. * * @default {} */ componentsProps?: { root?: React.HTMLAttributes<HTMLDivElement> & BackdropComponentsPropsOverrides; }; /** * Override or extend the styles applied to the component. */ classes?: Partial<BackdropClasses>; /** * If `true`, the backdrop is invisible. * It can be used when rendering a popover or a custom select component. * @default false */ invisible?: boolean; /** * If `true`, the component is shown. */ open: boolean; /** * The extra props for the slot components. * You can override the existing props or add new ones. * * This prop is an alias for the `componentsProps` prop, which will be deprecated in the future. * * @default {} */ slotProps?: { root?: React.HTMLAttributes<HTMLDivElement> & BackdropComponentsPropsOverrides; }; /** * The components used for each slot inside. * * This prop is an alias for the `components` prop, which will be deprecated in the future. * * @default {} */ slots?: { root?: React.ElementType; }; /** * The system prop that allows defining system overrides as well as additional CSS styles. */ sx?: SxProps<Theme>; /** * The duration for the transition, in milliseconds. * You may specify a single timeout for all transitions, or individually with an object. */ transitionDuration?: TransitionProps['timeout']; /** * The component used for the transition. * [Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component. * @default Fade */ TransitionComponent?: React.JSXElementConstructor< TransitionProps & { children: React.ReactElement<any, any> } >; }; defaultComponent: D; } type BackdropRootProps = NonNullable<BackdropTypeMap['props']['componentsProps']>['root']; export declare const BackdropRoot: React.FC<BackdropRootProps>; /** * * Demos: * * - [Backdrop](https://mui.com/material-ui/react-backdrop/) * * API: * * - [Backdrop API](https://mui.com/material-ui/api/backdrop/) * - inherits [Fade API](https://mui.com/material-ui/api/fade/) */ declare const Backdrop: OverridableComponent<BackdropTypeMap>; export type BackdropProps< D extends React.ElementType = BackdropTypeMap['defaultComponent'], P = {}, > = OverrideProps<BackdropTypeMap<P, D>, D>; export default Backdrop;