278 lines
9.5 KiB
JavaScript
278 lines
9.5 KiB
JavaScript
'use client';
|
|
|
|
import _extends from "@babel/runtime/helpers/esm/extends";
|
|
import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
|
|
const _excluded = ["children", "closeAfterTransition", "container", "disableAutoFocus", "disableEnforceFocus", "disableEscapeKeyDown", "disablePortal", "disableRestoreFocus", "disableScrollLock", "hideBackdrop", "keepMounted", "onBackdropClick", "onClose", "onKeyDown", "open", "onTransitionEnter", "onTransitionExited", "slotProps", "slots"];
|
|
import * as React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import { elementAcceptingRef, HTMLElementType } from '@mui/utils';
|
|
import { useSlotProps } from '../utils';
|
|
import { useClassNamesOverride } from '../utils/ClassNameConfigurator';
|
|
import { unstable_composeClasses as composeClasses } from '../composeClasses';
|
|
import { Portal } from '../Portal';
|
|
import { unstable_useModal as useModal } from '../unstable_useModal';
|
|
import { FocusTrap } from '../FocusTrap';
|
|
import { getModalUtilityClass } from './modalClasses';
|
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
import { jsxs as _jsxs } from "react/jsx-runtime";
|
|
const useUtilityClasses = ownerState => {
|
|
const {
|
|
open,
|
|
exited
|
|
} = ownerState;
|
|
const slots = {
|
|
root: ['root', !open && exited && 'hidden'],
|
|
backdrop: ['backdrop']
|
|
};
|
|
return composeClasses(slots, useClassNamesOverride(getModalUtilityClass));
|
|
};
|
|
|
|
/**
|
|
* Modal is a lower-level construct that is leveraged by the following components:
|
|
*
|
|
* * [Dialog](https://mui.com/material-ui/api/dialog/)
|
|
* * [Drawer](https://mui.com/material-ui/api/drawer/)
|
|
* * [Menu](https://mui.com/material-ui/api/menu/)
|
|
* * [Popover](https://mui.com/material-ui/api/popover/)
|
|
*
|
|
* If you are creating a modal dialog, you probably want to use the [Dialog](https://mui.com/material-ui/api/dialog/) component
|
|
* rather than directly using Modal.
|
|
*
|
|
* This component shares many concepts with [react-overlays](https://react-bootstrap.github.io/react-overlays/#modals).
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Modal](https://mui.com/base-ui/react-modal/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Modal API](https://mui.com/base-ui/react-modal/components-api/#modal)
|
|
*/
|
|
const Modal = /*#__PURE__*/React.forwardRef(function Modal(props, forwardedRef) {
|
|
var _slots$root;
|
|
const {
|
|
children,
|
|
closeAfterTransition = false,
|
|
container,
|
|
disableAutoFocus = false,
|
|
disableEnforceFocus = false,
|
|
disableEscapeKeyDown = false,
|
|
disablePortal = false,
|
|
disableRestoreFocus = false,
|
|
disableScrollLock = false,
|
|
hideBackdrop = false,
|
|
keepMounted = false,
|
|
onBackdropClick,
|
|
open,
|
|
slotProps = {},
|
|
slots = {}
|
|
} = props,
|
|
other = _objectWithoutPropertiesLoose(props, _excluded);
|
|
const propsWithDefaults = _extends({}, props, {
|
|
closeAfterTransition,
|
|
disableAutoFocus,
|
|
disableEnforceFocus,
|
|
disableEscapeKeyDown,
|
|
disablePortal,
|
|
disableRestoreFocus,
|
|
disableScrollLock,
|
|
hideBackdrop,
|
|
keepMounted
|
|
});
|
|
const {
|
|
getRootProps,
|
|
getBackdropProps,
|
|
getTransitionProps,
|
|
portalRef,
|
|
isTopModal,
|
|
exited,
|
|
hasTransition
|
|
} = useModal(_extends({}, propsWithDefaults, {
|
|
rootRef: forwardedRef
|
|
}));
|
|
const ownerState = _extends({}, propsWithDefaults, {
|
|
exited,
|
|
hasTransition
|
|
});
|
|
const classes = useUtilityClasses(ownerState);
|
|
const childProps = {};
|
|
if (children.props.tabIndex === undefined) {
|
|
childProps.tabIndex = '-1';
|
|
}
|
|
|
|
// It's a Transition like component
|
|
if (hasTransition) {
|
|
const {
|
|
onEnter,
|
|
onExited
|
|
} = getTransitionProps();
|
|
childProps.onEnter = onEnter;
|
|
childProps.onExited = onExited;
|
|
}
|
|
const Root = (_slots$root = slots.root) != null ? _slots$root : 'div';
|
|
const rootProps = useSlotProps({
|
|
elementType: Root,
|
|
externalSlotProps: slotProps.root,
|
|
externalForwardedProps: other,
|
|
getSlotProps: getRootProps,
|
|
className: classes.root,
|
|
ownerState
|
|
});
|
|
const BackdropComponent = slots.backdrop;
|
|
const backdropProps = useSlotProps({
|
|
elementType: BackdropComponent,
|
|
externalSlotProps: slotProps.backdrop,
|
|
getSlotProps: otherHandlers => {
|
|
return getBackdropProps(_extends({}, otherHandlers, {
|
|
onClick: e => {
|
|
if (onBackdropClick) {
|
|
onBackdropClick(e);
|
|
}
|
|
if (otherHandlers != null && otherHandlers.onClick) {
|
|
otherHandlers.onClick(e);
|
|
}
|
|
}
|
|
}));
|
|
},
|
|
className: classes.backdrop,
|
|
ownerState
|
|
});
|
|
if (!keepMounted && !open && (!hasTransition || exited)) {
|
|
return null;
|
|
}
|
|
return /*#__PURE__*/_jsx(Portal, {
|
|
ref: portalRef,
|
|
container: container,
|
|
disablePortal: disablePortal,
|
|
children: /*#__PURE__*/_jsxs(Root, _extends({}, rootProps, {
|
|
children: [!hideBackdrop && BackdropComponent ? /*#__PURE__*/_jsx(BackdropComponent, _extends({}, backdropProps)) : null, /*#__PURE__*/_jsx(FocusTrap, {
|
|
disableEnforceFocus: disableEnforceFocus,
|
|
disableAutoFocus: disableAutoFocus,
|
|
disableRestoreFocus: disableRestoreFocus,
|
|
isEnabled: isTopModal,
|
|
open: open,
|
|
children: /*#__PURE__*/React.cloneElement(children, childProps)
|
|
})]
|
|
}))
|
|
});
|
|
});
|
|
process.env.NODE_ENV !== "production" ? Modal.propTypes /* remove-proptypes */ = {
|
|
// ┌────────────────────────────── Warning ──────────────────────────────┐
|
|
// │ These PropTypes are generated from the TypeScript type definitions. │
|
|
// │ To update them, edit the TypeScript types and run `pnpm proptypes`. │
|
|
// └─────────────────────────────────────────────────────────────────────┘
|
|
/**
|
|
* A single child content element.
|
|
*/
|
|
children: elementAcceptingRef.isRequired,
|
|
/**
|
|
* When set to true the Modal waits until a nested Transition is completed before closing.
|
|
* @default false
|
|
*/
|
|
closeAfterTransition: PropTypes.bool,
|
|
/**
|
|
* An HTML element or function that returns one.
|
|
* The `container` will have the portal children appended to it.
|
|
*
|
|
* You can also provide a callback, which is called in a React layout effect.
|
|
* This lets you set the container from a ref, and also makes server-side rendering possible.
|
|
*
|
|
* By default, it uses the body of the top-level document object,
|
|
* so it's simply `document.body` most of the time.
|
|
*/
|
|
container: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([HTMLElementType, PropTypes.func]),
|
|
/**
|
|
* If `true`, the modal will not automatically shift focus to itself when it opens, and
|
|
* replace it to the last focused element when it closes.
|
|
* This also works correctly with any modal children that have the `disableAutoFocus` prop.
|
|
*
|
|
* Generally this should never be set to `true` as it makes the modal less
|
|
* accessible to assistive technologies, like screen readers.
|
|
* @default false
|
|
*/
|
|
disableAutoFocus: PropTypes.bool,
|
|
/**
|
|
* If `true`, the modal will not prevent focus from leaving the modal while open.
|
|
*
|
|
* Generally this should never be set to `true` as it makes the modal less
|
|
* accessible to assistive technologies, like screen readers.
|
|
* @default false
|
|
*/
|
|
disableEnforceFocus: PropTypes.bool,
|
|
/**
|
|
* If `true`, hitting escape will not fire the `onClose` callback.
|
|
* @default false
|
|
*/
|
|
disableEscapeKeyDown: PropTypes.bool,
|
|
/**
|
|
* The `children` will be under the DOM hierarchy of the parent component.
|
|
* @default false
|
|
*/
|
|
disablePortal: PropTypes.bool,
|
|
/**
|
|
* If `true`, the modal will not restore focus to previously focused element once
|
|
* modal is hidden or unmounted.
|
|
* @default false
|
|
*/
|
|
disableRestoreFocus: PropTypes.bool,
|
|
/**
|
|
* Disable the scroll lock behavior.
|
|
* @default false
|
|
*/
|
|
disableScrollLock: PropTypes.bool,
|
|
/**
|
|
* If `true`, the backdrop is not rendered.
|
|
* @default false
|
|
*/
|
|
hideBackdrop: PropTypes.bool,
|
|
/**
|
|
* Always keep the children in the DOM.
|
|
* This prop can be useful in SEO situation or
|
|
* when you want to maximize the responsiveness of the Modal.
|
|
* @default false
|
|
*/
|
|
keepMounted: PropTypes.bool,
|
|
/**
|
|
* Callback fired when the backdrop is clicked.
|
|
* @deprecated Use the `onClose` prop with the `reason` argument to handle the `backdropClick` events.
|
|
*/
|
|
onBackdropClick: PropTypes.func,
|
|
/**
|
|
* Callback fired when the component requests to be closed.
|
|
* The `reason` parameter can optionally be used to control the response to `onClose`.
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
* @param {string} reason Can be: `"escapeKeyDown"`, `"backdropClick"`.
|
|
*/
|
|
onClose: PropTypes.func,
|
|
/**
|
|
* A function called when a transition enters.
|
|
*/
|
|
onTransitionEnter: PropTypes.func,
|
|
/**
|
|
* A function called when a transition has exited.
|
|
*/
|
|
onTransitionExited: PropTypes.func,
|
|
/**
|
|
* If `true`, the component is shown.
|
|
*/
|
|
open: PropTypes.bool.isRequired,
|
|
/**
|
|
* The props used for each slot inside the Modal.
|
|
* @default {}
|
|
*/
|
|
slotProps: PropTypes.shape({
|
|
backdrop: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
|
|
root: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
|
|
}),
|
|
/**
|
|
* The components used for each slot inside the Modal.
|
|
* Either a string to use a HTML element or a component.
|
|
* @default {}
|
|
*/
|
|
slots: PropTypes.shape({
|
|
backdrop: PropTypes.elementType,
|
|
root: PropTypes.elementType
|
|
})
|
|
} : void 0;
|
|
export { Modal }; |