UNPKG

@material-ui/unstyled

Version:

Material-UI Unstyled - collection of unstyled React components.

976 lines (844 loc) 28.4 kB
import _extends from "@babel/runtime/helpers/esm/extends"; import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose"; 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_capitalize as capitalize, unstable_useControlled as useControlled } from '@material-ui/utils'; import ValueLabelComponent from './ValueLabelUnstyled'; function asc(a, b) { return a - b; } function clamp(value, min, max) { return Math.min(Math.max(min, value), max); } function findClosest(values, currentValue) { const { index: closestIndex } = values.reduce((acc, value, index) => { const distance = Math.abs(currentValue - value); if (acc === null || distance < acc.distance || distance === acc.distance) { return { distance, index }; } return acc; }, null); return closestIndex; } function trackFinger(event, touchId) { if (touchId.current !== undefined && event.changedTouches) { for (let i = 0; i < event.changedTouches.length; i += 1) { const 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) { const parts = num.toExponential().split('e-'); const matissaDecimalPart = parts[0].split('.')[1]; return (matissaDecimalPart ? matissaDecimalPart.length : 0) + parseInt(parts[1], 10); } const decimalPart = num.toString().split('.')[1]; return decimalPart ? decimalPart.length : 0; } function roundValueToStep(value, step, min) { const nearest = Math.round((value - min) / step) * step + min; return Number(nearest.toFixed(getDecimalPrecision(step))); } function setValueIndex({ values, source, newValue, index }) { // Performance shortcut if (source[index] === newValue) { return source; } const output = values.slice(); output[index] = newValue; return output; } function focusThumb({ sliderRef, activeIndex, setActive }) { const doc = ownerDocument(sliderRef.current); if (!sliderRef.current.contains(doc.activeElement) || Number(doc.activeElement.getAttribute('data-index')) !== activeIndex) { sliderRef.current.querySelector(`[role="slider"][data-index="${activeIndex}"]`).focus(); } if (setActive) { setActive(activeIndex); } } const axisProps = { horizontal: { offset: percent => ({ left: `${percent}%` }), leap: percent => ({ width: `${percent}%` }) }, 'horizontal-reverse': { offset: percent => ({ right: `${percent}%` }), leap: percent => ({ width: `${percent}%` }) }, vertical: { offset: percent => ({ bottom: `${percent}%` }), leap: percent => ({ height: `${percent}%` }) } }; const Identity = x => 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. let cachedSupportsTouchActionNone; function doesSupportTouchActionNone() { if (cachedSupportsTouchActionNone === undefined) { const element = document.createElement('div'); element.style.touchAction = 'none'; document.body.appendChild(element); cachedSupportsTouchActionNone = window.getComputedStyle(element).touchAction === 'none'; element.parentElement.removeChild(element); } return cachedSupportsTouchActionNone; } const getUtilityClass = name => { return `MuiSlider-${name}`; }; const useSliderClasses = props => { const { color, disabled, marked, orientation, track } = props; const utilityClasses = { root: clsx(getUtilityClass('root'), getUtilityClass(`color${capitalize(color)}`), disabled && 'Mui-disabled', marked && getUtilityClass('marked'), track === false && getUtilityClass('trackFalse'), orientation === 'vertical' && getUtilityClass('vertical'), track === 'inverted' && getUtilityClass('trackInverted')), rail: getUtilityClass('rail'), track: getUtilityClass('track'), mark: getUtilityClass('mark'), markLabel: getUtilityClass('markLabel'), valueLabel: getUtilityClass('valueLabel'), thumb: clsx(getUtilityClass('thumb'), getUtilityClass(`thumbColor${capitalize(color)}`), disabled && 'Mui-disabled') }; return utilityClasses; }; const isComponent = element => typeof element !== 'string'; const SliderUnstyled = /*#__PURE__*/React.forwardRef(function SliderUnstyled(props, ref) { const { 'aria-label': ariaLabel, 'aria-labelledby': ariaLabelledby, 'aria-valuetext': ariaValuetext, className, color = 'primary', component: Component = 'span', defaultValue, disabled = false, getAriaLabel, getAriaValueText, marks: marksProp = false, max = 100, min = 0, name, onChange, onChangeCommitted, onMouseDown, orientation = 'horizontal', scale = Identity, step = 1, track = 'normal', value: valueProp, valueLabelDisplay = 'off', valueLabelFormat = Identity, isRtl = false, components = {}, componentsProps = {}, /* eslint-disable react/prop-types */ theme } = props, other = _objectWithoutPropertiesLoose(props, ["aria-label", "aria-labelledby", "aria-valuetext", "className", "color", "component", "defaultValue", "disabled", "getAriaLabel", "getAriaValueText", "marks", "max", "min", "name", "onChange", "onChangeCommitted", "onMouseDown", "orientation", "scale", "step", "track", "value", "valueLabelDisplay", "valueLabelFormat", "isRtl", "components", "componentsProps", "theme"]); const 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. const [active, setActive] = React.useState(-1); const [open, setOpen] = React.useState(-1); const [valueDerived, setValueState] = useControlled({ controlled: valueProp, default: defaultValue, name: 'Slider' }); const handleChange = onChange && ((event, value) => { if (!(event instanceof Event)) event.persist(); // 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 Object.defineProperty(event, 'target', { writable: true, value: { value, name } }); onChange(event, value); }); const range = Array.isArray(valueDerived); let values = range ? valueDerived.slice().sort(asc) : [valueDerived]; values = values.map(value => clamp(value, min, max)); const marks = marksProp === true && step !== null ? [...Array(Math.floor((max - min) / step) + 1)].map((_, index) => ({ value: min + step * index })) : marksProp || []; const { isFocusVisibleRef, onBlur: handleBlurVisible, onFocus: handleFocusVisible, ref: focusVisibleRef } = useIsFocusVisible(); const [focusVisible, setFocusVisible] = React.useState(-1); const sliderRef = React.useRef(); const handleFocusRef = useForkRef(focusVisibleRef, sliderRef); const handleRef = useForkRef(ref, handleFocusRef); const handleFocus = useEventCallback(event => { const index = Number(event.currentTarget.getAttribute('data-index')); handleFocusVisible(event); if (isFocusVisibleRef.current === true) { setFocusVisible(index); } setOpen(index); }); const handleBlur = useEventCallback(event => { handleBlurVisible(event); if (isFocusVisibleRef.current === false) { setFocusVisible(-1); } setOpen(-1); }); const handleMouseOver = useEventCallback(event => { const index = Number(event.currentTarget.getAttribute('data-index')); setOpen(index); }); const handleMouseLeave = useEventCallback(() => { setOpen(-1); }); useEnhancedEffect(() => { 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); } const handleKeyDown = useEventCallback(event => { const index = Number(event.currentTarget.getAttribute('data-index')); const value = values[index]; const tenPercents = (max - min) / 10; const marksValues = marks.map(mark => mark.value); const marksIndex = marksValues.indexOf(value); let newValue; const increaseKey = isRtl ? 'ArrowLeft' : 'ArrowRight'; const decreaseKey = isRtl ? 'ArrowRight' : 'ArrowLeft'; switch (event.key) { case 'Home': newValue = min; break; case 'End': newValue = max; break; case 'PageUp': if (step) { newValue = value + tenPercents; } break; case 'PageDown': if (step) { newValue = value - tenPercents; } break; case increaseKey: case 'ArrowUp': if (step) { newValue = value + step; } else { newValue = marksValues[marksIndex + 1] || marksValues[marksValues.length - 1]; } break; case decreaseKey: case 'ArrowDown': if (step) { newValue = value - step; } else { newValue = marksValues[marksIndex - 1] || marksValues[0]; } break; default: return; } // Prevent scroll of the page event.preventDefault(); if (step) { newValue = roundValueToStep(newValue, step, min); } newValue = clamp(newValue, min, max); if (range) { const previousValue = newValue; newValue = setValueIndex({ values, source: valueDerived, newValue, index }).sort(asc); focusThumb({ sliderRef, activeIndex: newValue.indexOf(previousValue) }); } setValueState(newValue); setFocusVisible(index); if (handleChange) { handleChange(event, newValue); } if (onChangeCommitted) { onChangeCommitted(event, newValue); } }); const previousIndex = React.useRef(); let axis = orientation; if (isRtl && orientation !== "vertical") { axis += '-reverse'; } const getFingerNewValue = ({ finger, move = false, values: values2, source }) => { const { current: slider } = sliderRef; const { width, height, bottom, left } = slider.getBoundingClientRect(); let 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; } let newValue; newValue = percentToValue(percent, min, max); if (step) { newValue = roundValueToStep(newValue, step, min); } else { const marksValues = marks.map(mark => mark.value); const closestIndex = findClosest(marksValues, newValue); newValue = marksValues[closestIndex]; } newValue = clamp(newValue, min, max); let activeIndex = 0; if (range) { if (!move) { activeIndex = findClosest(values2, newValue); } else { activeIndex = previousIndex.current; } const previousValue = newValue; newValue = setValueIndex({ values: values2, source, newValue, index: activeIndex }).sort(asc); activeIndex = newValue.indexOf(previousValue); previousIndex.current = activeIndex; } return { newValue, activeIndex }; }; const handleTouchMove = useEventCallback(nativeEvent => { const finger = trackFinger(nativeEvent, touchId); if (!finger) { return; } // 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; } const { newValue, activeIndex } = getFingerNewValue({ finger, move: true, values, source: valueDerived }); focusThumb({ sliderRef, activeIndex, setActive }); setValueState(newValue); if (handleChange) { handleChange(nativeEvent, newValue); } }); const handleTouchEnd = useEventCallback(nativeEvent => { const finger = trackFinger(nativeEvent, touchId); if (!finger) { return; } const { newValue } = getFingerNewValue({ finger, values, source: valueDerived }); 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(); }); const handleTouchStart = useEventCallback(event => { // If touch-action: none; is not supported we need to prevent the scroll manually. if (!doesSupportTouchActionNone()) { event.preventDefault(); } const touch = event.changedTouches[0]; if (touch != null) { // A number that uniquely identifies the current finger in the touch session. touchId.current = touch.identifier; } const finger = trackFinger(event, touchId); const { newValue, activeIndex } = getFingerNewValue({ finger, values, source: valueDerived }); focusThumb({ sliderRef, activeIndex, setActive }); setValueState(newValue); if (handleChange) { handleChange(event, newValue); } const doc = ownerDocument(sliderRef.current); doc.addEventListener('touchmove', handleTouchMove); doc.addEventListener('touchend', handleTouchEnd); }); const stopListening = React.useCallback(() => { const doc = ownerDocument(sliderRef.current); doc.removeEventListener('mousemove', handleTouchMove); doc.removeEventListener('mouseup', handleTouchEnd); doc.removeEventListener('touchmove', handleTouchMove); doc.removeEventListener('touchend', handleTouchEnd); }, [handleTouchEnd, handleTouchMove]); React.useEffect(() => { const { current: slider } = sliderRef; slider.addEventListener('touchstart', handleTouchStart, { passive: doesSupportTouchActionNone() }); return () => { slider.removeEventListener('touchstart', handleTouchStart, { passive: doesSupportTouchActionNone() }); stopListening(); }; }, [stopListening, handleTouchStart]); React.useEffect(() => { if (disabled) { stopListening(); } }, [disabled, stopListening]); const handleMouseDown = useEventCallback(event => { if (onMouseDown) { onMouseDown(event); } // Only handle left clicks if (event.button !== 0) { return; } // Avoid text selection event.preventDefault(); const finger = trackFinger(event, touchId); const { newValue, activeIndex } = getFingerNewValue({ finger, values, source: valueDerived }); focusThumb({ sliderRef, activeIndex, setActive }); setValueState(newValue); if (handleChange) { handleChange(event, newValue); } const doc = ownerDocument(sliderRef.current); doc.addEventListener('mousemove', handleTouchMove); doc.addEventListener('mouseup', handleTouchEnd); }); const trackOffset = valueToPercent(range ? values[0] : min, min, max); const trackLeap = valueToPercent(values[values.length - 1], min, max) - trackOffset; const trackStyle = _extends({}, axisProps[axis].offset(trackOffset), axisProps[axis].leap(trackLeap)); const Root = components.Root || Component; const rootProps = componentsProps.root || {}; const Rail = components.Rail || 'span'; const railProps = componentsProps.rail || {}; const Track = components.Track || 'span'; const trackProps = componentsProps.track || {}; const Thumb = components.Thumb || 'span'; const thumbProps = componentsProps.thumb || {}; const ValueLabel = components.ValueLabel || ValueLabelComponent; const valueLabelProps = componentsProps.valueLabel || {}; const Mark = components.Mark || 'span'; const markProps = componentsProps.mark || {}; const MarkLabel = components.MarkLabel || 'span'; const markLabelProps = componentsProps.markLabel || {}; // all props with defaults // consider extracting to hook an reusing the lint rule for the varints const stateAndProps = _extends({}, props, { color, disabled, max, min, orientation, scale, step, track, valueLabelDisplay, valueLabelFormat, isRtl, marked: marks.length > 0 && marks.some(mark => mark.label) }); const utilityClasses = useSliderClasses(stateAndProps); return /*#__PURE__*/React.createElement(Root, _extends({ ref: handleRef, onMouseDown: handleMouseDown }, isComponent(Root) && { styleProps: stateAndProps, theme }, rootProps, other, { className: clsx(utilityClasses.root, rootProps.className, className) }), /*#__PURE__*/React.createElement(Rail, _extends({}, railProps, { className: clsx(utilityClasses.rail, railProps.className) })), /*#__PURE__*/React.createElement(Track, _extends({}, trackProps, { className: clsx(utilityClasses.track, trackProps.className), style: _extends({}, trackStyle, trackProps.style) })), /*#__PURE__*/React.createElement("input", { value: values.join(','), name: name, type: "hidden" }), marks.map((mark, index) => { const percent = 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__*/React.createElement(React.Fragment, { key: mark.value }, /*#__PURE__*/React.createElement(Mark, _extends({ "data-index": index }, markProps, { style: _extends({}, style, markProps.style), className: clsx(utilityClasses.mark, markProps.className, markActive && getUtilityClass('markActive')) })), mark.label != null ? /*#__PURE__*/React.createElement(MarkLabel, _extends({ "aria-hidden": true, "data-index": index }, markLabelProps, { style: _extends({}, style, markLabelProps.style), className: clsx(utilityClasses.markLabel, markLabelProps.className, markActive && getUtilityClass('markLabelActive')) }), mark.label) : null); }), values.map((value, index) => { const percent = valueToPercent(value, min, max); const style = axisProps[axis].offset(percent); return /*#__PURE__*/React.createElement(ValueLabel, _extends({ key: index, valueLabelFormat: valueLabelFormat, valueLabelDisplay: valueLabelDisplay, value: typeof valueLabelFormat === 'function' ? valueLabelFormat(scale(value), index) : valueLabelFormat }, isComponent(ValueLabel) && { styleProps: stateAndProps, theme }, { index: index, open: open === index || active === index || valueLabelDisplay === 'on', disabled: disabled }, valueLabelProps, { className: clsx(utilityClasses.valueLabel, valueLabelProps.className) }), /*#__PURE__*/React.createElement(Thumb, _extends({}, thumbProps, { className: clsx(utilityClasses.thumb, thumbProps.className, active === index && 'Mui-active', disabled && 'Mui-disabled', focusVisible === index && 'Mui-focusVisible'), tabIndex: disabled ? null : 0, role: "slider", style: _extends({}, style, thumbProps.style), "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, onKeyDown: handleKeyDown, onFocus: handleFocus, onBlur: handleBlur, onMouseOver: handleMouseOver, onMouseLeave: handleMouseLeave }))); })); }); process.env.NODE_ENV !== "production" ? SliderUnstyled.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, props => { const range = Array.isArray(props.value || props.defaultValue); if (range && props['aria-label'] != null) { return new Error('Material-UI: 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, props => { const range = Array.isArray(props.value || props.defaultValue); if (range && props['aria-valuetext'] != null) { return new Error('Material-UI: You need to use the `getAriaValueText` prop instead of `aria-valuetext` when using a range slider.'); } return null; }), /** * @ignore */ children: PropTypes.node, /** * @ignore */ className: PropTypes.string, /** * The color of the component. It supports those theme colors that make sense for this component. * @default 'primary' */ color: PropTypes.oneOf(['primary', 'secondary']), /** * 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 element value. Use when the component is not controlled. */ defaultValue: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.number), PropTypes.number]), /** * If `true`, the slider is disabled. * @default false */ disabled: PropTypes.bool, /** * Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. * * @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. * * @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 {object} event The event source of the callback. **Warning**: This is a generic event not a change event. * @param {number | number[]} value The new value. */ onChange: PropTypes.func, /** * Callback function that is fired when the `mouseup` is triggered. * * @param {object} 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 slider 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, /** * 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;