@mui/base
Version:
A library of headless ('unstyled') React UI components and low-level hooks.
434 lines (431 loc) • 18.4 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
var React = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _clsx = _interopRequireDefault(require("clsx"));
var _utils = require("@mui/utils");
var _isHostComponent = _interopRequireDefault(require("../utils/isHostComponent"));
var _composeClasses = _interopRequireDefault(require("../composeClasses"));
var _sliderClasses = require("./sliderClasses");
var _useSlider = _interopRequireWildcard(require("../useSlider"));
var _useSlotProps = _interopRequireDefault(require("../utils/useSlotProps"));
var _ClassNameConfigurator = require("../utils/ClassNameConfigurator");
var _jsxRuntime = require("react/jsx-runtime");
const _excluded = ["aria-label", "aria-valuetext", "aria-labelledby", "className", "disableSwap", "disabled", "getAriaLabel", "getAriaValueText", "marks", "max", "min", "name", "onChange", "onChangeCommitted", "orientation", "scale", "step", "tabIndex", "track", "value", "valueLabelFormat", "isRtl", "defaultValue", "slotProps", "slots"]; // @ts-ignore
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; }
function Identity(x) {
return x;
}
const useUtilityClasses = ownerState => {
const {
disabled,
dragging,
marked,
orientation,
track
} = ownerState;
const slots = {
root: ['root', disabled && 'disabled', dragging && 'dragging', marked && 'marked', orientation === 'vertical' && 'vertical', track === 'inverted' && 'trackInverted', track === false && 'trackFalse'],
rail: ['rail'],
track: ['track'],
mark: ['mark'],
markActive: ['markActive'],
markLabel: ['markLabel'],
markLabelActive: ['markLabelActive'],
valueLabel: ['valueLabel'],
thumb: ['thumb', disabled && 'disabled'],
active: ['active'],
disabled: ['disabled'],
focusVisible: ['focusVisible']
};
return (0, _composeClasses.default)(slots, (0, _ClassNameConfigurator.useClassNamesOverride)(_sliderClasses.getSliderUtilityClass));
};
/**
*
* Demos:
*
* - [Slider](https://mui.com/base/react-slider/)
*
* API:
*
* - [Slider API](https://mui.com/base/react-slider/components-api/#slider)
*/
const Slider = /*#__PURE__*/React.forwardRef(function Slider(props, forwardedRef) {
var _slots$root, _slots$rail, _slots$track, _slots$thumb, _slots$mark, _slots$markLabel;
const {
'aria-label': ariaLabel,
'aria-valuetext': ariaValuetext,
'aria-labelledby': ariaLabelledby,
className,
disableSwap = false,
disabled = false,
getAriaLabel,
getAriaValueText,
marks: marksProp = false,
max = 100,
min = 0,
orientation = 'horizontal',
scale = Identity,
step = 1,
track = 'normal',
valueLabelFormat = Identity,
isRtl = false,
defaultValue,
slotProps = {},
slots = {}
} = props,
other = (0, _objectWithoutPropertiesLoose2.default)(props, _excluded);
// all props with defaults
// consider extracting to hook an reusing the lint rule for the variants
const partialOwnerState = (0, _extends2.default)({}, props, {
marks: marksProp,
disabled,
isRtl,
defaultValue,
max,
min,
orientation,
scale,
step,
track,
valueLabelFormat
});
const {
axisProps,
getRootProps,
getHiddenInputProps,
getThumbProps,
active,
axis,
range,
focusedThumbIndex,
dragging,
marks,
values,
trackOffset,
trackLeap
} = (0, _useSlider.default)((0, _extends2.default)({}, partialOwnerState, {
rootRef: forwardedRef
}));
const ownerState = (0, _extends2.default)({}, partialOwnerState, {
marked: marks.length > 0 && marks.some(mark => mark.label),
dragging,
focusedThumbIndex
});
const classes = useUtilityClasses(ownerState);
const Root = (_slots$root = slots.root) != null ? _slots$root : 'span';
const rootProps = (0, _useSlotProps.default)({
elementType: Root,
getSlotProps: getRootProps,
externalSlotProps: slotProps.root,
externalForwardedProps: other,
ownerState,
className: [classes.root, className]
});
const Rail = (_slots$rail = slots.rail) != null ? _slots$rail : 'span';
const railProps = (0, _useSlotProps.default)({
elementType: Rail,
externalSlotProps: slotProps.rail,
ownerState,
className: classes.rail
});
const Track = (_slots$track = slots.track) != null ? _slots$track : 'span';
const trackProps = (0, _useSlotProps.default)({
elementType: Track,
externalSlotProps: slotProps.track,
additionalProps: {
style: (0, _extends2.default)({}, axisProps[axis].offset(trackOffset), axisProps[axis].leap(trackLeap))
},
ownerState,
className: classes.track
});
const Thumb = (_slots$thumb = slots.thumb) != null ? _slots$thumb : 'span';
const thumbProps = (0, _useSlotProps.default)({
elementType: Thumb,
getSlotProps: getThumbProps,
externalSlotProps: slotProps.thumb,
ownerState
});
const ValueLabel = slots.valueLabel;
const valueLabelProps = (0, _useSlotProps.default)({
elementType: ValueLabel,
externalSlotProps: slotProps.valueLabel,
ownerState
});
const Mark = (_slots$mark = slots.mark) != null ? _slots$mark : 'span';
const markProps = (0, _useSlotProps.default)({
elementType: Mark,
externalSlotProps: slotProps.mark,
ownerState,
className: classes.mark
});
const MarkLabel = (_slots$markLabel = slots.markLabel) != null ? _slots$markLabel : 'span';
const markLabelProps = (0, _useSlotProps.default)({
elementType: MarkLabel,
externalSlotProps: slotProps.markLabel,
ownerState
});
const Input = slots.input || 'input';
const inputProps = (0, _useSlotProps.default)({
elementType: Input,
getSlotProps: getHiddenInputProps,
externalSlotProps: slotProps.input,
ownerState
});
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(Root, (0, _extends2.default)({}, rootProps, {
children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(Rail, (0, _extends2.default)({}, railProps)), /*#__PURE__*/(0, _jsxRuntime.jsx)(Track, (0, _extends2.default)({}, trackProps)), marks.filter(mark => mark.value >= min && mark.value <= max).map((mark, index) => {
const percent = (0, _useSlider.valueToPercent)(mark.value, min, max);
const style = axisProps[axis].offset(percent);
let markActive;
if (track === false) {
markActive = values.indexOf(mark.value) !== -1;
} else {
markActive = track === 'normal' && (range ? mark.value >= values[0] && mark.value <= values[values.length - 1] : mark.value <= values[0]) || track === 'inverted' && (range ? mark.value <= values[0] || mark.value >= values[values.length - 1] : mark.value >= values[0]);
}
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(React.Fragment, {
children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(Mark, (0, _extends2.default)({
"data-index": index
}, markProps, !(0, _isHostComponent.default)(Mark) && {
markActive
}, {
style: (0, _extends2.default)({}, style, markProps.style),
className: (0, _clsx.default)(markProps.className, markActive && classes.markActive)
})), mark.label != null ? /*#__PURE__*/(0, _jsxRuntime.jsx)(MarkLabel, (0, _extends2.default)({
"aria-hidden": true,
"data-index": index
}, markLabelProps, !(0, _isHostComponent.default)(MarkLabel) && {
markLabelActive: markActive
}, {
style: (0, _extends2.default)({}, style, markLabelProps.style),
className: (0, _clsx.default)(classes.markLabel, markLabelProps.className, markActive && classes.markLabelActive),
children: mark.label
})) : null]
}, index);
}), values.map((value, index) => {
const percent = (0, _useSlider.valueToPercent)(value, min, max);
const style = axisProps[axis].offset(percent);
return /*#__PURE__*/(0, _jsxRuntime.jsxs)(Thumb, (0, _extends2.default)({
"data-index": index
}, thumbProps, {
className: (0, _clsx.default)(classes.thumb, thumbProps.className, active === index && classes.active, focusedThumbIndex === index && classes.focusVisible),
style: (0, _extends2.default)({}, style, {
pointerEvents: disableSwap && active !== index ? 'none' : undefined
}, thumbProps.style),
children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(Input, (0, _extends2.default)({
"data-index": index,
"aria-label": getAriaLabel ? getAriaLabel(index) : ariaLabel,
"aria-valuenow": scale(value),
"aria-labelledby": ariaLabelledby,
"aria-valuetext": getAriaValueText ? getAriaValueText(scale(value), index) : ariaValuetext,
value: values[index]
}, inputProps)), ValueLabel ? /*#__PURE__*/(0, _jsxRuntime.jsx)(ValueLabel, (0, _extends2.default)({}, !(0, _isHostComponent.default)(ValueLabel) && {
valueLabelFormat,
index,
disabled
}, valueLabelProps, {
children: typeof valueLabelFormat === 'function' ? valueLabelFormat(scale(value), index) : valueLabelFormat
})) : null]
}), index);
})]
}));
});
process.env.NODE_ENV !== "production" ? Slider.propTypes /* remove-proptypes */ = {
// ----------------------------- Warning --------------------------------
// | These PropTypes are generated from the TypeScript type definitions |
// | To update them edit TypeScript types and run "yarn proptypes" |
// ----------------------------------------------------------------------
/**
* The label of the slider.
*/
'aria-label': (0, _utils.chainPropTypes)(_propTypes.default.string, props => {
const range = Array.isArray(props.value || props.defaultValue);
if (range && props['aria-label'] != null) {
return new Error('MUI: You need to use the `getAriaLabel` prop instead of `aria-label` when using a range slider.');
}
return null;
}),
/**
* The id of the element containing a label for the slider.
*/
'aria-labelledby': _propTypes.default.string,
/**
* A string value that provides a user-friendly name for the current value of the slider.
*/
'aria-valuetext': (0, _utils.chainPropTypes)(_propTypes.default.string, props => {
const range = Array.isArray(props.value || props.defaultValue);
if (range && props['aria-valuetext'] != null) {
return new Error('MUI: You need to use the `getAriaValueText` prop instead of `aria-valuetext` when using a range slider.');
}
return null;
}),
/**
* The default value. Use when the component is not controlled.
*/
defaultValue: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.number), _propTypes.default.number]),
/**
* If `true`, the component is disabled.
* @default false
*/
disabled: _propTypes.default.bool,
/**
* If `true`, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.
* @default false
*/
disableSwap: _propTypes.default.bool,
/**
* Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider.
* This is important for screen reader users.
* @param {number} index The thumb label's index to format.
* @returns {string}
*/
getAriaLabel: _propTypes.default.func,
/**
* Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider.
* This is important for screen reader users.
* @param {number} value The thumb label's value to format.
* @param {number} index The thumb label's index to format.
* @returns {string}
*/
getAriaValueText: _propTypes.default.func,
/**
* If `true` the Slider will be rendered right-to-left (with the lowest value on the right-hand side).
* @default false
*/
isRtl: _propTypes.default.bool,
/**
* Marks indicate predetermined values to which the user can move the slider.
* If `true` the marks are spaced according the value of the `step` prop.
* If an array, it should contain objects with `value` and an optional `label` keys.
* @default false
*/
marks: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.shape({
label: _propTypes.default.node,
value: _propTypes.default.number.isRequired
})), _propTypes.default.bool]),
/**
* The maximum allowed value of the slider.
* Should not be equal to min.
* @default 100
*/
max: _propTypes.default.number,
/**
* The minimum allowed value of the slider.
* Should not be equal to max.
* @default 0
*/
min: _propTypes.default.number,
/**
* Name attribute of the hidden `input` element.
*/
name: _propTypes.default.string,
/**
* Callback function that is fired when the slider's value changed.
*
* @param {Event} event The event source of the callback.
* You can pull out the new value by accessing `event.target.value` (any).
* **Warning**: This is a generic event not a change event.
* @param {number | number[]} value The new value.
* @param {number} activeThumb Index of the currently moved thumb.
*/
onChange: _propTypes.default.func,
/**
* Callback function that is fired when the `mouseup` is triggered.
*
* @param {React.SyntheticEvent | Event} event The event source of the callback. **Warning**: This is a generic event not a change event.
* @param {number | number[]} value The new value.
*/
onChangeCommitted: _propTypes.default.func,
/**
* The component orientation.
* @default 'horizontal'
*/
orientation: _propTypes.default.oneOf(['horizontal', 'vertical']),
/**
* A transformation function, to change the scale of the slider.
* @param {any} x
* @returns {any}
* @default function Identity(x) {
* return x;
* }
*/
scale: _propTypes.default.func,
/**
* The props used for each slot inside the Slider.
* @default {}
*/
slotProps: _propTypes.default.shape({
input: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
mark: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
markLabel: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
rail: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
root: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
thumb: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
track: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.object]),
valueLabel: _propTypes.default.oneOfType([_propTypes.default.any, _propTypes.default.func])
}),
/**
* The components used for each slot inside the Slider.
* Either a string to use a HTML element or a component.
* @default {}
*/
slots: _propTypes.default.shape({
input: _propTypes.default.elementType,
mark: _propTypes.default.elementType,
markLabel: _propTypes.default.elementType,
rail: _propTypes.default.elementType,
root: _propTypes.default.elementType,
thumb: _propTypes.default.elementType,
track: _propTypes.default.elementType,
valueLabel: _propTypes.default.elementType
}),
/**
* The granularity with which the slider can step through values. (A "discrete" slider.)
* The `min` prop serves as the origin for the valid values.
* We recommend (max - min) to be evenly divisible by the step.
*
* When step is `null`, the thumb can only be slid onto marks provided with the `marks` prop.
* @default 1
*/
step: _propTypes.default.number,
/**
* Tab index attribute of the hidden `input` element.
*/
tabIndex: _propTypes.default.number,
/**
* The track presentation:
*
* - `normal` the track will render a bar representing the slider value.
* - `inverted` the track will render a bar representing the remaining slider value.
* - `false` the track will render without a bar.
* @default 'normal'
*/
track: _propTypes.default.oneOf(['inverted', 'normal', false]),
/**
* The value of the slider.
* For ranged sliders, provide an array with two values.
*/
value: _propTypes.default.oneOfType([_propTypes.default.arrayOf(_propTypes.default.number), _propTypes.default.number]),
/**
* The format function the value label's value.
*
* When a function is provided, it should have the following signature:
*
* - {number} value The value label's value to format
* - {number} index The value label's index to format
* @param {any} x
* @returns {any}
* @default function Identity(x) {
* return x;
* }
*/
valueLabelFormat: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.string])
} : void 0;
var _default = Slider;
exports.default = _default;