UNPKG

@mui/core

Version:

Unstyled React components with which to implement custom design systems.

1,069 lines (923 loc) 35 kB
import _extends from "@babel/runtime/helpers/esm/extends"; import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray"; import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray"; import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties"; import * as React from 'react'; import PropTypes from 'prop-types'; import clsx from 'clsx'; import { chainPropTypes, unstable_useIsFocusVisible as useIsFocusVisible, unstable_useEnhancedEffect as useEnhancedEffect, unstable_ownerDocument as ownerDocument, unstable_useEventCallback as useEventCallback, unstable_useForkRef as useForkRef, unstable_useControlled as useControlled, visuallyHidden } from '@mui/utils'; import isHostComponent from '../utils/isHostComponent'; import composeClasses from '../composeClasses'; import { getSliderUtilityClass } from './sliderUnstyledClasses'; import SliderValueLabelUnstyled from './SliderValueLabelUnstyled'; import { jsx as _jsx } from "react/jsx-runtime"; import { jsxs as _jsxs } from "react/jsx-runtime"; var INTENTIONAL_DRAG_COUNT_THRESHOLD = 2; function asc(a, b) { return a - b; } function clamp(value, min, max) { if (value == null) { return min; } return Math.min(Math.max(min, value), max); } function findClosest(values, currentValue) { var _values$reduce = values.reduce(function (acc, value, index) { var distance = Math.abs(currentValue - value); if (acc === null || distance < acc.distance || distance === acc.distance) { return { distance: distance, index: index }; } return acc; }, null), closestIndex = _values$reduce.index; return closestIndex; } function trackFinger(event, touchId) { if (touchId.current !== undefined && event.changedTouches) { for (var i = 0; i < event.changedTouches.length; i += 1) { var touch = event.changedTouches[i]; if (touch.identifier === touchId.current) { return { x: touch.clientX, y: touch.clientY }; } } return false; } return { x: event.clientX, y: event.clientY }; } function valueToPercent(value, min, max) { return (value - min) * 100 / (max - min); } function percentToValue(percent, min, max) { return (max - min) * percent + min; } function getDecimalPrecision(num) { // This handles the case when num is very small (0.00000001), js will turn this into 1e-8. // When num is bigger than 1 or less than -1 it won't get converted to this notation so it's fine. if (Math.abs(num) < 1) { var parts = num.toExponential().split('e-'); var matissaDecimalPart = parts[0].split('.')[1]; return (matissaDecimalPart ? matissaDecimalPart.length : 0) + parseInt(parts[1], 10); } var decimalPart = num.toString().split('.')[1]; return decimalPart ? decimalPart.length : 0; } function roundValueToStep(value, step, min) { var nearest = Math.round((value - min) / step) * step + min; return Number(nearest.toFixed(getDecimalPrecision(step))); } function setValueIndex(_ref) { var values = _ref.values, newValue = _ref.newValue, index = _ref.index; var output = values.slice(); output[index] = newValue; return output.sort(asc); } function focusThumb(_ref2) { var sliderRef = _ref2.sliderRef, activeIndex = _ref2.activeIndex, setActive = _ref2.setActive; var doc = ownerDocument(sliderRef.current); if (!sliderRef.current.contains(doc.activeElement) || Number(doc.activeElement.getAttribute('data-index')) !== activeIndex) { sliderRef.current.querySelector("[type=\"range\"][data-index=\"".concat(activeIndex, "\"]")).focus(); } if (setActive) { setActive(activeIndex); } } var axisProps = { horizontal: { offset: function offset(percent) { return { left: "".concat(percent, "%") }; }, leap: function leap(percent) { return { width: "".concat(percent, "%") }; } }, 'horizontal-reverse': { offset: function offset(percent) { return { right: "".concat(percent, "%") }; }, leap: function leap(percent) { return { width: "".concat(percent, "%") }; } }, vertical: { offset: function offset(percent) { return { bottom: "".concat(percent, "%") }; }, leap: function leap(percent) { return { height: "".concat(percent, "%") }; } } }; var Identity = function Identity(x) { return x; }; // TODO: remove support for Safari < 13. // https://caniuse.com/#search=touch-action // // Safari, on iOS, supports touch action since v13. // Over 80% of the iOS phones are compatible // in August 2020. // Utilizing the CSS.supports method to check if touch-action is supported. // Since CSS.supports is supported on all but Edge@12 and IE and touch-action // is supported on both Edge@12 and IE if CSS.supports is not available that means that // touch-action will be supported var cachedSupportsTouchActionNone; function doesSupportTouchActionNone() { if (cachedSupportsTouchActionNone === undefined) { if (typeof CSS !== 'undefined' && typeof CSS.supports === 'function') { cachedSupportsTouchActionNone = CSS.supports('touch-action', 'none'); } else { cachedSupportsTouchActionNone = true; } } return cachedSupportsTouchActionNone; } var useUtilityClasses = function useUtilityClasses(ownerState) { var disabled = ownerState.disabled, dragging = ownerState.dragging, marked = ownerState.marked, orientation = ownerState.orientation, track = ownerState.track, classes = ownerState.classes; var 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 composeClasses(slots, getSliderUtilityClass, classes); }; var Forward = function Forward(_ref3) { var children = _ref3.children; return children; }; var SliderUnstyled = /*#__PURE__*/React.forwardRef(function SliderUnstyled(props, ref) { var ariaLabel = props['aria-label'], ariaLabelledby = props['aria-labelledby'], ariaValuetext = props['aria-valuetext'], className = props.className, _props$component = props.component, component = _props$component === void 0 ? 'span' : _props$component, classesProp = props.classes, defaultValue = props.defaultValue, _props$disableSwap = props.disableSwap, disableSwap = _props$disableSwap === void 0 ? false : _props$disableSwap, _props$disabled = props.disabled, disabled = _props$disabled === void 0 ? false : _props$disabled, getAriaLabel = props.getAriaLabel, getAriaValueText = props.getAriaValueText, _props$marks = props.marks, marksProp = _props$marks === void 0 ? false : _props$marks, _props$max = props.max, max = _props$max === void 0 ? 100 : _props$max, _props$min = props.min, min = _props$min === void 0 ? 0 : _props$min, name = props.name, onChange = props.onChange, onChangeCommitted = props.onChangeCommitted, onMouseDown = props.onMouseDown, _props$orientation = props.orientation, orientation = _props$orientation === void 0 ? 'horizontal' : _props$orientation, _props$scale = props.scale, scale = _props$scale === void 0 ? Identity : _props$scale, _props$step = props.step, step = _props$step === void 0 ? 1 : _props$step, tabIndex = props.tabIndex, _props$track = props.track, track = _props$track === void 0 ? 'normal' : _props$track, valueProp = props.value, _props$valueLabelDisp = props.valueLabelDisplay, valueLabelDisplay = _props$valueLabelDisp === void 0 ? 'off' : _props$valueLabelDisp, _props$valueLabelForm = props.valueLabelFormat, valueLabelFormat = _props$valueLabelForm === void 0 ? Identity : _props$valueLabelForm, _props$isRtl = props.isRtl, isRtl = _props$isRtl === void 0 ? false : _props$isRtl, _props$components = props.components, components = _props$components === void 0 ? {} : _props$components, _props$componentsProp = props.componentsProps, componentsProps = _props$componentsProp === void 0 ? {} : _props$componentsProp, other = _objectWithoutProperties(props, ["aria-label", "aria-labelledby", "aria-valuetext", "className", "component", "classes", "defaultValue", "disableSwap", "disabled", "getAriaLabel", "getAriaValueText", "marks", "max", "min", "name", "onChange", "onChangeCommitted", "onMouseDown", "orientation", "scale", "step", "tabIndex", "track", "value", "valueLabelDisplay", "valueLabelFormat", "isRtl", "components", "componentsProps"]); var touchId = React.useRef(); // We can't use the :active browser pseudo-classes. // - The active state isn't triggered when clicking on the rail. // - The active state isn't transferred when inversing a range slider. var _React$useState = React.useState(-1), active = _React$useState[0], setActive = _React$useState[1]; var _React$useState2 = React.useState(-1), open = _React$useState2[0], setOpen = _React$useState2[1]; var _React$useState3 = React.useState(false), dragging = _React$useState3[0], setDragging = _React$useState3[1]; var moveCount = React.useRef(0); var _useControlled = useControlled({ controlled: valueProp, default: defaultValue != null ? defaultValue : min, name: 'Slider' }), _useControlled2 = _slicedToArray(_useControlled, 2), valueDerived = _useControlled2[0], setValueState = _useControlled2[1]; var handleChange = onChange && function (event, value, thumbIndex) { // Redefine target to allow name and value to be read. // This allows seamless integration with the most popular form libraries. // https://github.com/mui-org/material-ui/issues/13485#issuecomment-676048492 // Clone the event to not override `target` of the original event. var nativeEvent = event.nativeEvent || event; var clonedEvent = new nativeEvent.constructor(nativeEvent.type, nativeEvent); Object.defineProperty(clonedEvent, 'target', { writable: true, value: { value: value, name: name } }); onChange(clonedEvent, value, thumbIndex); }; var range = Array.isArray(valueDerived); var values = range ? valueDerived.slice().sort(asc) : [valueDerived]; values = values.map(function (value) { return clamp(value, min, max); }); var marks = marksProp === true && step !== null ? _toConsumableArray(Array(Math.floor((max - min) / step) + 1)).map(function (_, index) { return { value: min + step * index }; }) : marksProp || []; var _useIsFocusVisible = useIsFocusVisible(), isFocusVisibleRef = _useIsFocusVisible.isFocusVisibleRef, handleBlurVisible = _useIsFocusVisible.onBlur, handleFocusVisible = _useIsFocusVisible.onFocus, focusVisibleRef = _useIsFocusVisible.ref; var _React$useState4 = React.useState(-1), focusVisible = _React$useState4[0], setFocusVisible = _React$useState4[1]; var sliderRef = React.useRef(); var handleFocusRef = useForkRef(focusVisibleRef, sliderRef); var handleRef = useForkRef(ref, handleFocusRef); var handleFocus = function handleFocus(event) { var index = Number(event.currentTarget.getAttribute('data-index')); handleFocusVisible(event); if (isFocusVisibleRef.current === true) { setFocusVisible(index); } setOpen(index); }; var handleBlur = function handleBlur(event) { handleBlurVisible(event); if (isFocusVisibleRef.current === false) { setFocusVisible(-1); } setOpen(-1); }; var handleMouseOver = useEventCallback(function (event) { var index = Number(event.currentTarget.getAttribute('data-index')); setOpen(index); }); var handleMouseLeave = useEventCallback(function () { setOpen(-1); }); useEnhancedEffect(function () { if (disabled && sliderRef.current.contains(document.activeElement)) { // This is necessary because Firefox and Safari will keep focus // on a disabled element: // https://codesandbox.io/s/mui-pr-22247-forked-h151h?file=/src/App.js document.activeElement.blur(); } }, [disabled]); if (disabled && active !== -1) { setActive(-1); } if (disabled && focusVisible !== -1) { setFocusVisible(-1); } var handleHiddenInputChange = function handleHiddenInputChange(event) { var index = Number(event.currentTarget.getAttribute('data-index')); var value = values[index]; var marksValues = marks.map(function (mark) { return mark.value; }); var marksIndex = marksValues.indexOf(value); var newValue = event.target.valueAsNumber; if (marks && step == null) { newValue = newValue < value ? marksValues[marksIndex - 1] : marksValues[marksIndex + 1]; } newValue = clamp(newValue, min, max); if (marks && step == null) { var markValues = marks.map(function (mark) { return mark.value; }); var currentMarkIndex = markValues.indexOf(values[index]); newValue = newValue < values[index] ? markValues[currentMarkIndex - 1] : markValues[currentMarkIndex + 1]; } if (range) { // Bound the new value to the thumb's neighbours. if (disableSwap) { newValue = clamp(newValue, values[index - 1] || -Infinity, values[index + 1] || Infinity); } var previousValue = newValue; newValue = setValueIndex({ values: values, newValue: newValue, index: index }); var activeIndex = index; // Potentially swap the index if needed. if (!disableSwap) { activeIndex = newValue.indexOf(previousValue); } focusThumb({ sliderRef: sliderRef, activeIndex: activeIndex }); } setValueState(newValue); setFocusVisible(index); if (handleChange) { handleChange(event, newValue, index); } if (onChangeCommitted) { onChangeCommitted(event, newValue); } }; var previousIndex = React.useRef(); var axis = orientation; if (isRtl && orientation !== "vertical") { axis += '-reverse'; } var getFingerNewValue = function getFingerNewValue(_ref4) { var finger = _ref4.finger, _ref4$move = _ref4.move, move = _ref4$move === void 0 ? false : _ref4$move, values2 = _ref4.values; var slider = sliderRef.current; var _slider$getBoundingCl = slider.getBoundingClientRect(), width = _slider$getBoundingCl.width, height = _slider$getBoundingCl.height, bottom = _slider$getBoundingCl.bottom, left = _slider$getBoundingCl.left; var percent; if (axis.indexOf('vertical') === 0) { percent = (bottom - finger.y) / height; } else { percent = (finger.x - left) / width; } if (axis.indexOf('-reverse') !== -1) { percent = 1 - percent; } var newValue; newValue = percentToValue(percent, min, max); if (step) { newValue = roundValueToStep(newValue, step, min); } else { var marksValues = marks.map(function (mark) { return mark.value; }); var closestIndex = findClosest(marksValues, newValue); newValue = marksValues[closestIndex]; } newValue = clamp(newValue, min, max); var activeIndex = 0; if (range) { if (!move) { activeIndex = findClosest(values2, newValue); } else { activeIndex = previousIndex.current; } // Bound the new value to the thumb's neighbours. if (disableSwap) { newValue = clamp(newValue, values2[activeIndex - 1] || -Infinity, values2[activeIndex + 1] || Infinity); } var previousValue = newValue; newValue = setValueIndex({ values: values2, newValue: newValue, index: activeIndex }); // Potentially swap the index if needed. if (!(disableSwap && move)) { activeIndex = newValue.indexOf(previousValue); previousIndex.current = activeIndex; } } return { newValue: newValue, activeIndex: activeIndex }; }; var handleTouchMove = useEventCallback(function (nativeEvent) { var finger = trackFinger(nativeEvent, touchId); if (!finger) { return; } moveCount.current += 1; // Cancel move in case some other element consumed a mouseup event and it was not fired. if (nativeEvent.type === 'mousemove' && nativeEvent.buttons === 0) { // eslint-disable-next-line @typescript-eslint/no-use-before-define handleTouchEnd(nativeEvent); return; } var _getFingerNewValue = getFingerNewValue({ finger: finger, move: true, values: values }), newValue = _getFingerNewValue.newValue, activeIndex = _getFingerNewValue.activeIndex; focusThumb({ sliderRef: sliderRef, activeIndex: activeIndex, setActive: setActive }); setValueState(newValue); if (!dragging && moveCount.current > INTENTIONAL_DRAG_COUNT_THRESHOLD) { setDragging(true); } if (handleChange) { handleChange(nativeEvent, newValue, activeIndex); } }); var handleTouchEnd = useEventCallback(function (nativeEvent) { var finger = trackFinger(nativeEvent, touchId); setDragging(false); if (!finger) { return; } var _getFingerNewValue2 = getFingerNewValue({ finger: finger, values: values }), newValue = _getFingerNewValue2.newValue; setActive(-1); if (nativeEvent.type === 'touchend') { setOpen(-1); } if (onChangeCommitted) { onChangeCommitted(nativeEvent, newValue); } touchId.current = undefined; // eslint-disable-next-line @typescript-eslint/no-use-before-define stopListening(); }); var handleTouchStart = useEventCallback(function (nativeEvent) { // If touch-action: none; is not supported we need to prevent the scroll manually. if (!doesSupportTouchActionNone()) { nativeEvent.preventDefault(); } var touch = nativeEvent.changedTouches[0]; if (touch != null) { // A number that uniquely identifies the current finger in the touch session. touchId.current = touch.identifier; } var finger = trackFinger(nativeEvent, touchId); var _getFingerNewValue3 = getFingerNewValue({ finger: finger, values: values }), newValue = _getFingerNewValue3.newValue, activeIndex = _getFingerNewValue3.activeIndex; focusThumb({ sliderRef: sliderRef, activeIndex: activeIndex, setActive: setActive }); setValueState(newValue); if (handleChange) { handleChange(nativeEvent, newValue, activeIndex); } moveCount.current = 0; var doc = ownerDocument(sliderRef.current); doc.addEventListener('touchmove', handleTouchMove); doc.addEventListener('touchend', handleTouchEnd); }); var stopListening = React.useCallback(function () { var doc = ownerDocument(sliderRef.current); doc.removeEventListener('mousemove', handleTouchMove); doc.removeEventListener('mouseup', handleTouchEnd); doc.removeEventListener('touchmove', handleTouchMove); doc.removeEventListener('touchend', handleTouchEnd); }, [handleTouchEnd, handleTouchMove]); React.useEffect(function () { var slider = sliderRef.current; slider.addEventListener('touchstart', handleTouchStart, { passive: doesSupportTouchActionNone() }); return function () { slider.removeEventListener('touchstart', handleTouchStart, { passive: doesSupportTouchActionNone() }); stopListening(); }; }, [stopListening, handleTouchStart]); React.useEffect(function () { if (disabled) { stopListening(); } }, [disabled, stopListening]); var handleMouseDown = useEventCallback(function (event) { if (onMouseDown) { onMouseDown(event); } // Only handle left clicks if (event.button !== 0) { return; } // Avoid text selection event.preventDefault(); var finger = trackFinger(event, touchId); var _getFingerNewValue4 = getFingerNewValue({ finger: finger, values: values }), newValue = _getFingerNewValue4.newValue, activeIndex = _getFingerNewValue4.activeIndex; focusThumb({ sliderRef: sliderRef, activeIndex: activeIndex, setActive: setActive }); setValueState(newValue); if (handleChange) { handleChange(event, newValue, activeIndex); } moveCount.current = 0; var doc = ownerDocument(sliderRef.current); doc.addEventListener('mousemove', handleTouchMove); doc.addEventListener('mouseup', handleTouchEnd); }); var trackOffset = valueToPercent(range ? values[0] : min, min, max); var trackLeap = valueToPercent(values[values.length - 1], min, max) - trackOffset; var trackStyle = _extends({}, axisProps[axis].offset(trackOffset), axisProps[axis].leap(trackLeap)); var Root = components.Root || component; var rootProps = componentsProps.root || {}; var Rail = components.Rail || 'span'; var railProps = componentsProps.rail || {}; var Track = components.Track || 'span'; var trackProps = componentsProps.track || {}; var Thumb = components.Thumb || 'span'; var thumbProps = componentsProps.thumb || {}; var ValueLabel = components.ValueLabel || SliderValueLabelUnstyled; var valueLabelProps = componentsProps.valueLabel || {}; var Mark = components.Mark || 'span'; var markProps = componentsProps.mark || {}; var MarkLabel = components.MarkLabel || 'span'; var markLabelProps = componentsProps.markLabel || {}; // all props with defaults // consider extracting to hook an reusing the lint rule for the varints var ownerState = _extends({}, props, { classes: classesProp, disabled: disabled, dragging: dragging, isRtl: isRtl, marked: marks.length > 0 && marks.some(function (mark) { return mark.label; }), max: max, min: min, orientation: orientation, scale: scale, step: step, track: track, valueLabelDisplay: valueLabelDisplay, valueLabelFormat: valueLabelFormat }); var classes = useUtilityClasses(ownerState); return /*#__PURE__*/_jsxs(Root, _extends({ ref: handleRef, onMouseDown: handleMouseDown }, rootProps, !isHostComponent(Root) && { as: component, ownerState: _extends({}, ownerState, rootProps.ownerState) }, other, { className: clsx(classes.root, rootProps.className, className), children: [/*#__PURE__*/_jsx(Rail, _extends({}, railProps, !isHostComponent(Rail) && { ownerState: _extends({}, ownerState, railProps.ownerState) }, { className: clsx(classes.rail, railProps.className) })), /*#__PURE__*/_jsx(Track, _extends({}, trackProps, !isHostComponent(Track) && { ownerState: _extends({}, ownerState, trackProps.ownerState) }, { className: clsx(classes.track, trackProps.className), style: _extends({}, trackStyle, trackProps.style) })), marks.map(function (mark, index) { var percent = valueToPercent(mark.value, min, max); var style = axisProps[axis].offset(percent); var 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__*/_jsxs(React.Fragment, { children: [/*#__PURE__*/_jsx(Mark, _extends({ "data-index": index }, markProps, !isHostComponent(Mark) && { ownerState: _extends({}, ownerState, markProps.ownerState), markActive: markActive }, { style: _extends({}, style, markProps.style), className: clsx(classes.mark, markProps.className, markActive && classes.markActive) })), mark.label != null ? /*#__PURE__*/_jsx(MarkLabel, _extends({ "aria-hidden": true, "data-index": index }, markLabelProps, !isHostComponent(MarkLabel) && { ownerState: _extends({}, ownerState, markLabelProps.ownerState) }, { markLabelActive: markActive, style: _extends({}, style, markLabelProps.style), className: clsx(classes.markLabel, markLabelProps.className, markActive && classes.markLabelActive), children: mark.label })) : null] }, mark.value); }), values.map(function (value, index) { var percent = valueToPercent(value, min, max); var style = axisProps[axis].offset(percent); var ValueLabelComponent = valueLabelDisplay === 'off' ? Forward : ValueLabel; return /*#__PURE__*/_jsx(React.Fragment, { children: /*#__PURE__*/_jsx(ValueLabelComponent, _extends({ valueLabelFormat: valueLabelFormat, valueLabelDisplay: valueLabelDisplay, value: typeof valueLabelFormat === 'function' ? valueLabelFormat(scale(value), index) : valueLabelFormat, index: index, open: open === index || active === index || valueLabelDisplay === 'on', disabled: disabled }, valueLabelProps, { className: clsx(classes.valueLabel, valueLabelProps.className) }, !isHostComponent(ValueLabel) && { ownerState: _extends({}, ownerState, valueLabelProps.ownerState) }, { children: /*#__PURE__*/_jsx(Thumb, _extends({ "data-index": index, onMouseOver: handleMouseOver, onMouseLeave: handleMouseLeave }, thumbProps, { className: clsx(classes.thumb, thumbProps.className, active === index && classes.active, focusVisible === index && classes.focusVisible) }, !isHostComponent(Thumb) && { ownerState: _extends({}, ownerState, thumbProps.ownerState) }, { style: _extends({}, style, { pointerEvents: disableSwap && active !== index ? 'none' : undefined }, thumbProps.style), children: /*#__PURE__*/_jsx("input", { tabIndex: tabIndex, "data-index": index, "aria-label": getAriaLabel ? getAriaLabel(index) : ariaLabel, "aria-labelledby": ariaLabelledby, "aria-orientation": orientation, "aria-valuemax": scale(max), "aria-valuemin": scale(min), "aria-valuenow": scale(value), "aria-valuetext": getAriaValueText ? getAriaValueText(scale(value), index) : ariaValuetext, onFocus: handleFocus, onBlur: handleBlur, name: name, type: "range", min: props.min, max: props.max, step: props.step, disabled: disabled, value: values[index], onChange: handleHiddenInputChange, style: _extends({}, visuallyHidden, { direction: isRtl ? 'rtl' : 'ltr', // So that VoiceOver's focus indicator matches the thumb's dimensions width: '100%', height: '100%' }) }) })) })) }, index); })] })); }); process.env.NODE_ENV !== "production" ? SliderUnstyled.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 label of the slider. */ 'aria-label': chainPropTypes(PropTypes.string, function (props) { var 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.string, /** * A string value that provides a user-friendly name for the current value of the slider. */ 'aria-valuetext': chainPropTypes(PropTypes.string, function (props) { var 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; }), /** * @ignore */ children: PropTypes.node, /** * Override or extend the styles applied to the component. */ classes: PropTypes.object, /** * @ignore */ className: PropTypes.string, /** * The component used for the root node. * Either a string to use a HTML element or a component. */ component: PropTypes.elementType, /** * The components used for each slot inside the Slider. * Either a string to use a HTML element or a component. * @default {} */ components: PropTypes.shape({ Mark: PropTypes.elementType, MarkLabel: PropTypes.elementType, Rail: PropTypes.elementType, Root: PropTypes.elementType, Thumb: PropTypes.elementType, Track: PropTypes.elementType, ValueLabel: PropTypes.elementType }), /** * The props used for each slot inside the Slider. * @default {} */ componentsProps: PropTypes.object, /** * The default value. Use when the component is not controlled. */ defaultValue: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.number), PropTypes.number]), /** * If `true`, the component is disabled. * @default false */ disabled: PropTypes.bool, /** * If `true`, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb. * @default false */ disableSwap: PropTypes.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.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.func, /** * Indicates whether the theme context has rtl direction. It is set automatically. * @default false */ isRtl: PropTypes.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.oneOfType([PropTypes.arrayOf(PropTypes.shape({ label: PropTypes.node, value: PropTypes.number.isRequired })), PropTypes.bool]), /** * The maximum allowed value of the slider. * Should not be equal to min. * @default 100 */ max: PropTypes.number, /** * The minimum allowed value of the slider. * Should not be equal to max. * @default 0 */ min: PropTypes.number, /** * Name attribute of the hidden `input` element. */ name: PropTypes.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.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.func, /** * @ignore */ onMouseDown: PropTypes.func, /** * The component orientation. * @default 'horizontal' */ orientation: PropTypes.oneOf(['horizontal', 'vertical']), /** * A transformation function, to change the scale of the slider. * @default (x) => x */ scale: PropTypes.func, /** * 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.number, /** * Tab index attribute of the hidden `input` element. */ tabIndex: PropTypes.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.oneOf(['inverted', 'normal', false]), /** * The value of the slider. * For ranged sliders, provide an array with two values. */ value: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.number), PropTypes.number]), /** * Controls when the value label is displayed: * * - `auto` the value label will display when the thumb is hovered or focused. * - `on` will display persistently. * - `off` will never display. * @default 'off' */ valueLabelDisplay: PropTypes.oneOf(['auto', 'off', 'on']), /** * 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 * @default (x) => x */ valueLabelFormat: PropTypes.oneOfType([PropTypes.func, PropTypes.string]) } : void 0; export default SliderUnstyled;