@mui/material
Version:
Quickly build beautiful React apps. MUI is a simple and customizable component library to build faster, beautiful, and more accessible React applications. Follow your own design system, or start with Material Design.
587 lines (502 loc) • 17.7 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var React = _interopRequireWildcard(require("react"));
var _reactIs = require("react-is");
var _propTypes = _interopRequireDefault(require("prop-types"));
var _clsx = _interopRequireDefault(require("clsx"));
var _base = require("@mui/base");
var _styled = _interopRequireDefault(require("../styles/styled"));
var _useThemeProps = _interopRequireDefault(require("../styles/useThemeProps"));
var _createTransitions = require("../styles/createTransitions");
var _Zoom = _interopRequireDefault(require("../Zoom"));
var _Fab = _interopRequireDefault(require("../Fab"));
var _capitalize = _interopRequireDefault(require("../utils/capitalize"));
var _isMuiElement = _interopRequireDefault(require("../utils/isMuiElement"));
var _useForkRef = _interopRequireDefault(require("../utils/useForkRef"));
var _useControlled = _interopRequireDefault(require("../utils/useControlled"));
var _speedDialClasses = _interopRequireWildcard(require("./speedDialClasses"));
var _jsxRuntime = require("react/jsx-runtime");
const _excluded = ["ref"],
_excluded2 = ["ariaLabel", "FabProps", "children", "className", "direction", "hidden", "icon", "onBlur", "onClose", "onFocus", "onKeyDown", "onMouseEnter", "onMouseLeave", "onOpen", "open", "openIcon", "TransitionComponent", "transitionDuration", "TransitionProps"],
_excluded3 = ["ref"];
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
const useUtilityClasses = ownerState => {
const {
classes,
open,
direction
} = ownerState;
const slots = {
root: ['root', `direction${(0, _capitalize.default)(direction)}`],
fab: ['fab'],
actions: ['actions', !open && 'actionsClosed']
};
return (0, _base.unstable_composeClasses)(slots, _speedDialClasses.getSpeedDialUtilityClass, classes);
};
function getOrientation(direction) {
if (direction === 'up' || direction === 'down') {
return 'vertical';
}
if (direction === 'right' || direction === 'left') {
return 'horizontal';
}
return undefined;
}
function clamp(value, min, max) {
if (value < min) {
return min;
}
if (value > max) {
return max;
}
return value;
}
const dialRadius = 32;
const spacingActions = 16;
const SpeedDialRoot = (0, _styled.default)('div', {
name: 'MuiSpeedDial',
slot: 'Root',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [styles.root, styles[`direction${(0, _capitalize.default)(ownerState.direction)}`]];
}
})(({
theme,
ownerState
}) => (0, _extends2.default)({
zIndex: theme.zIndex.speedDial,
display: 'flex',
alignItems: 'center',
pointerEvents: 'none'
}, ownerState.direction === 'up' && {
flexDirection: 'column-reverse',
[`& .${_speedDialClasses.default.actions}`]: {
flexDirection: 'column-reverse',
marginBottom: -dialRadius,
paddingBottom: spacingActions + dialRadius
}
}, ownerState.direction === 'down' && {
flexDirection: 'column',
[`& .${_speedDialClasses.default.actions}`]: {
flexDirection: 'column',
marginTop: -dialRadius,
paddingTop: spacingActions + dialRadius
}
}, ownerState.direction === 'left' && {
flexDirection: 'row-reverse',
[`& .${_speedDialClasses.default.actions}`]: {
flexDirection: 'row-reverse',
marginRight: -dialRadius,
paddingRight: spacingActions + dialRadius
}
}, ownerState.direction === 'right' && {
flexDirection: 'row',
[`& .${_speedDialClasses.default.actions}`]: {
flexDirection: 'row',
marginLeft: -dialRadius,
paddingLeft: spacingActions + dialRadius
}
}));
const SpeedDialFab = (0, _styled.default)(_Fab.default, {
name: 'MuiSpeedDial',
slot: 'Fab',
overridesResolver: (props, styles) => styles.fab
})(() => ({
pointerEvents: 'auto'
}));
const SpeedDialActions = (0, _styled.default)('div', {
name: 'MuiSpeedDial',
slot: 'Actions',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [styles.actions, !ownerState.open && styles.actionsClosed];
}
})(({
ownerState
}) => (0, _extends2.default)({
display: 'flex',
pointerEvents: 'auto'
}, !ownerState.open && {
transition: 'top 0s linear 0.2s',
pointerEvents: 'none'
}));
const SpeedDial = /*#__PURE__*/React.forwardRef(function SpeedDial(inProps, ref) {
const props = (0, _useThemeProps.default)({
props: inProps,
name: 'MuiSpeedDial'
});
const {
ariaLabel,
FabProps: {
ref: origDialButtonRef
} = {},
children: childrenProp,
className,
direction = 'up',
hidden = false,
icon,
onBlur,
onClose,
onFocus,
onKeyDown,
onMouseEnter,
onMouseLeave,
onOpen,
open: openProp,
TransitionComponent = _Zoom.default,
transitionDuration = {
enter: _createTransitions.duration.enteringScreen,
exit: _createTransitions.duration.leavingScreen
},
TransitionProps
} = props,
FabProps = (0, _objectWithoutPropertiesLoose2.default)(props.FabProps, _excluded),
other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded2);
const [open, setOpenState] = (0, _useControlled.default)({
controlled: openProp,
default: false,
name: 'SpeedDial',
state: 'open'
});
const ownerState = (0, _extends2.default)({}, props, {
open,
direction
});
const classes = useUtilityClasses(ownerState);
const eventTimer = React.useRef();
React.useEffect(() => {
return () => {
clearTimeout(eventTimer.current);
};
}, []);
/**
* an index in actions.current
*/
const focusedAction = React.useRef(0);
/**
* pressing this key while the focus is on a child SpeedDialAction focuses
* the next SpeedDialAction.
* It is equal to the first arrow key pressed while focus is on the SpeedDial
* that is not orthogonal to the direction.
* @type {utils.ArrowKey?}
*/
const nextItemArrowKey = React.useRef();
/**
* refs to the Button that have an action associated to them in this SpeedDial
* [Fab, ...(SpeedDialActions > Button)]
* @type {HTMLButtonElement[]}
*/
const actions = React.useRef([]);
actions.current = [actions.current[0]];
const handleOwnFabRef = React.useCallback(fabFef => {
actions.current[0] = fabFef;
}, []);
const handleFabRef = (0, _useForkRef.default)(origDialButtonRef, handleOwnFabRef);
/**
* creates a ref callback for the Button in a SpeedDialAction
* Is called before the original ref callback for Button that was set in buttonProps
*
* @param dialActionIndex {number}
* @param origButtonRef {React.RefObject?}
*/
const createHandleSpeedDialActionButtonRef = (dialActionIndex, origButtonRef) => {
return buttonRef => {
actions.current[dialActionIndex + 1] = buttonRef;
if (origButtonRef) {
origButtonRef(buttonRef);
}
};
};
const handleKeyDown = event => {
if (onKeyDown) {
onKeyDown(event);
}
const key = event.key.replace('Arrow', '').toLowerCase();
const {
current: nextItemArrowKeyCurrent = key
} = nextItemArrowKey;
if (event.key === 'Escape') {
setOpenState(false);
actions.current[0].focus();
if (onClose) {
onClose(event, 'escapeKeyDown');
}
return;
}
if (getOrientation(key) === getOrientation(nextItemArrowKeyCurrent) && getOrientation(key) !== undefined) {
event.preventDefault();
const actionStep = key === nextItemArrowKeyCurrent ? 1 : -1; // stay within array indices
const nextAction = clamp(focusedAction.current + actionStep, 0, actions.current.length - 1);
actions.current[nextAction].focus();
focusedAction.current = nextAction;
nextItemArrowKey.current = nextItemArrowKeyCurrent;
}
};
React.useEffect(() => {
// actions were closed while navigation state was not reset
if (!open) {
focusedAction.current = 0;
nextItemArrowKey.current = undefined;
}
}, [open]);
const handleClose = event => {
if (event.type === 'mouseleave' && onMouseLeave) {
onMouseLeave(event);
}
if (event.type === 'blur' && onBlur) {
onBlur(event);
}
clearTimeout(eventTimer.current);
if (event.type === 'blur') {
eventTimer.current = setTimeout(() => {
setOpenState(false);
if (onClose) {
onClose(event, 'blur');
}
});
} else {
setOpenState(false);
if (onClose) {
onClose(event, 'mouseLeave');
}
}
};
const handleClick = event => {
if (FabProps.onClick) {
FabProps.onClick(event);
}
clearTimeout(eventTimer.current);
if (open) {
setOpenState(false);
if (onClose) {
onClose(event, 'toggle');
}
} else {
setOpenState(true);
if (onOpen) {
onOpen(event, 'toggle');
}
}
};
const handleOpen = event => {
if (event.type === 'mouseenter' && onMouseEnter) {
onMouseEnter(event);
}
if (event.type === 'focus' && onFocus) {
onFocus(event);
} // When moving the focus between two items,
// a chain if blur and focus event is triggered.
// We only handle the last event.
clearTimeout(eventTimer.current);
if (!open) {
// Wait for a future focus or click event
eventTimer.current = setTimeout(() => {
setOpenState(true);
if (onOpen) {
const eventMap = {
focus: 'focus',
mouseenter: 'mouseEnter'
};
onOpen(event, eventMap[event.type]);
}
});
}
}; // Filter the label for valid id characters.
const id = ariaLabel.replace(/^[^a-z]+|[^\w:.-]+/gi, '');
const allItems = React.Children.toArray(childrenProp).filter(child => {
if (process.env.NODE_ENV !== 'production') {
if ((0, _reactIs.isFragment)(child)) {
console.error(["MUI: The SpeedDial component doesn't accept a Fragment as a child.", 'Consider providing an array instead.'].join('\n'));
}
}
return /*#__PURE__*/React.isValidElement(child);
});
const children = allItems.map((child, index) => {
const _child$props = child.props,
{
FabProps: {
ref: origButtonRef
} = {},
tooltipPlacement: tooltipPlacementProp
} = _child$props,
ChildFabProps = (0, _objectWithoutPropertiesLoose2.default)(_child$props.FabProps, _excluded3);
const tooltipPlacement = tooltipPlacementProp || (getOrientation(direction) === 'vertical' ? 'left' : 'top');
return /*#__PURE__*/React.cloneElement(child, {
FabProps: (0, _extends2.default)({}, ChildFabProps, {
ref: createHandleSpeedDialActionButtonRef(index, origButtonRef)
}),
delay: 30 * (open ? index : allItems.length - index),
open,
tooltipPlacement,
id: `${id}-action-${index}`
});
});
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(SpeedDialRoot, (0, _extends2.default)({
className: (0, _clsx.default)(classes.root, className),
ref: ref,
role: "presentation",
onKeyDown: handleKeyDown,
onBlur: handleClose,
onFocus: handleOpen,
onMouseEnter: handleOpen,
onMouseLeave: handleClose,
ownerState: ownerState
}, other, {
children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(TransitionComponent, (0, _extends2.default)({
in: !hidden,
timeout: transitionDuration,
unmountOnExit: true
}, TransitionProps, {
children: /*#__PURE__*/(0, _jsxRuntime.jsx)(SpeedDialFab, (0, _extends2.default)({
color: "primary",
"aria-label": ariaLabel,
"aria-haspopup": "true",
"aria-expanded": open,
"aria-controls": `${id}-actions`
}, FabProps, {
onClick: handleClick,
className: (0, _clsx.default)(classes.fab, FabProps.className),
ref: handleFabRef,
ownerState: ownerState,
children: /*#__PURE__*/React.isValidElement(icon) && (0, _isMuiElement.default)(icon, ['SpeedDialIcon']) ? /*#__PURE__*/React.cloneElement(icon, {
open
}) : icon
}))
})), /*#__PURE__*/(0, _jsxRuntime.jsx)(SpeedDialActions, {
id: `${id}-actions`,
role: "menu",
"aria-orientation": getOrientation(direction),
className: (0, _clsx.default)(classes.actions, !open && classes.actionsClosed),
ownerState: ownerState,
children: children
})]
}));
});
process.env.NODE_ENV !== "production" ? SpeedDial.propTypes
/* remove-proptypes */
= {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit the d.ts file and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* The aria-label of the button element.
* Also used to provide the `id` for the `SpeedDial` element and its children.
*/
ariaLabel: _propTypes.default.string.isRequired,
/**
* SpeedDialActions to display when the SpeedDial is `open`.
*/
children: _propTypes.default.node,
/**
* Override or extend the styles applied to the component.
*/
classes: _propTypes.default.object,
/**
* @ignore
*/
className: _propTypes.default.string,
/**
* The direction the actions open relative to the floating action button.
* @default 'up'
*/
direction: _propTypes.default.oneOf(['down', 'left', 'right', 'up']),
/**
* Props applied to the [`Fab`](/api/fab/) element.
* @default {}
*/
FabProps: _propTypes.default.object,
/**
* If `true`, the SpeedDial is hidden.
* @default false
*/
hidden: _propTypes.default.bool,
/**
* The icon to display in the SpeedDial Fab. The `SpeedDialIcon` component
* provides a default Icon with animation.
*/
icon: _propTypes.default.node,
/**
* @ignore
*/
onBlur: _propTypes.default.func,
/**
* Callback fired when the component requests to be closed.
*
* @param {object} event The event source of the callback.
* @param {string} reason Can be: `"toggle"`, `"blur"`, `"mouseLeave"`, `"escapeKeyDown"`.
*/
onClose: _propTypes.default.func,
/**
* @ignore
*/
onFocus: _propTypes.default.func,
/**
* @ignore
*/
onKeyDown: _propTypes.default.func,
/**
* @ignore
*/
onMouseEnter: _propTypes.default.func,
/**
* @ignore
*/
onMouseLeave: _propTypes.default.func,
/**
* Callback fired when the component requests to be open.
*
* @param {object} event The event source of the callback.
* @param {string} reason Can be: `"toggle"`, `"focus"`, `"mouseEnter"`.
*/
onOpen: _propTypes.default.func,
/**
* If `true`, the component is shown.
*/
open: _propTypes.default.bool,
/**
* The icon to display in the SpeedDial Fab when the SpeedDial is open.
*/
openIcon: _propTypes.default.node,
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object, _propTypes.default.bool])), _propTypes.default.func, _propTypes.default.object]),
/**
* The component used for the transition.
* [Follow this guide](/components/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
* @default Zoom
*/
TransitionComponent: _propTypes.default.elementType,
/**
* The duration for the transition, in milliseconds.
* You may specify a single timeout for all transitions, or individually with an object.
* @default {
* enter: duration.enteringScreen,
* exit: duration.leavingScreen,
* }
*/
transitionDuration: _propTypes.default.oneOfType([_propTypes.default.number, _propTypes.default.shape({
appear: _propTypes.default.number,
enter: _propTypes.default.number,
exit: _propTypes.default.number
})]),
/**
* Props applied to the transition element.
* By default, the element is based on this [`Transition`](http://reactcommunity.org/react-transition-group/transition/) component.
*/
TransitionProps: _propTypes.default.object
} : void 0;
var _default = SpeedDial;
exports.default = _default;