@elastic/eui
Version:
Elastic UI Component Library
419 lines (418 loc) • 19.5 kB
JavaScript
var _excluded = ["className", "compressed", "disabled", "fullWidth", "isLoading", "readOnly", "id", "max", "min", "name", "step", "showLabels", "showInput", "inputPopoverProps", "showTicks", "tickInterval", "ticks", "levels", "showRange", "showValue", "valueAppend", "valuePrepend", "onBlur", "onChange", "onFocus", "value", "tabIndex", "isInvalid", "theme"];
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], t.indexOf(o) >= 0 || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.indexOf(n) >= 0) continue; t[n] = r[n]; } return t; }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, e); }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import React, { Component } from 'react';
import PropTypes from "prop-types";
import classNames from 'classnames';
import { isWithinRange } from '../../../services/number';
import { EuiInputPopover } from '../../popover';
import { htmlIdGenerator, withEuiTheme } from '../../../services/';
import { FormContext } from '../eui_form_context';
import { getLevelColor } from './range_levels_colors';
import { EuiRangeHighlight } from './range_highlight';
import { EuiRangeInput } from './range_input';
import { EuiRangeLabel } from './range_label';
import { EuiRangeSlider } from './range_slider';
import { EuiRangeTooltip } from './range_tooltip';
import { EuiRangeTrack } from './range_track';
import { EuiRangeWrapper } from './range_wrapper';
import { euiRangeStyles } from './range.styles';
import { EuiI18n } from '../../i18n';
import { jsx as ___EmotionJSX } from "@emotion/react";
export var EuiRangeClass = /*#__PURE__*/function (_Component) {
function EuiRangeClass() {
var _this;
_classCallCheck(this, EuiRangeClass);
for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
_this = _callSuper(this, EuiRangeClass, [].concat(args));
_defineProperty(_this, "preventPopoverClose", false);
_defineProperty(_this, "state", {
id: _this.props.id || htmlIdGenerator()(),
isPopoverOpen: false,
trackWidth: 0
});
_defineProperty(_this, "handleOnChange", function (e) {
var isValid = isWithinRange(_this.props.min, _this.props.max, e.currentTarget.value);
if (_this.props.onChange) {
_this.props.onChange(e, isValid);
}
});
_defineProperty(_this, "setTrackWidth", function (_ref) {
var width = _ref.width;
_this.setState({
trackWidth: width
});
});
_defineProperty(_this, "onInputFocus", function (e) {
if (_this.props.onFocus) {
_this.props.onFocus(e);
}
_this.setState({
isPopoverOpen: true
});
});
_defineProperty(_this, "onInputBlur", function (e) {
return setTimeout(function () {
// Safari does not recognize any focus-related eventing for input[type=range]
// making it impossible to capture its state using active/focus/relatedTarget
// Instead, a prevention flag is set on mousedown, with a waiting period here.
// Mousedown is viable because in the popover case, it is inaccessible via keyboard (intentionally)
if (_this.preventPopoverClose) {
_this.preventPopoverClose = false;
return;
}
if (_this.props.onBlur) {
_this.props.onBlur(e);
}
_this.closePopover();
}, 200);
});
_defineProperty(_this, "closePopover", function () {
_this.preventPopoverClose = false;
_this.setState({
isPopoverOpen: false
});
});
_defineProperty(_this, "handleAriaValueText", function (ticks, currentVal) {
var target = ticks.find(function (tick) {
return tick.value.toString() === currentVal.toString();
});
if (target) {
return target.accessibleLabel ? "".concat(target.value, ", (").concat(target.accessibleLabel, ")") : typeof target.label === 'string' // Fall back to the label if it's a usable string
? "".concat(target.value, ", (").concat(target.label, ")") : undefined;
}
});
return _this;
}
_inherits(EuiRangeClass, _Component);
return _createClass(EuiRangeClass, [{
key: "isValid",
get: function get() {
return isWithinRange(this.props.min, this.props.max, this.props.value || '');
}
}, {
key: "render",
value: function render() {
var _this2 = this;
var _ref2 = this.context,
defaultFullWidth = _ref2.defaultFullWidth;
var _this$props = this.props,
className = _this$props.className,
compressed = _this$props.compressed,
disabled = _this$props.disabled,
_this$props$fullWidth = _this$props.fullWidth,
fullWidth = _this$props$fullWidth === void 0 ? defaultFullWidth : _this$props$fullWidth,
isLoading = _this$props.isLoading,
readOnly = _this$props.readOnly,
propsId = _this$props.id,
max = _this$props.max,
min = _this$props.min,
name = _this$props.name,
step = _this$props.step,
showLabels = _this$props.showLabels,
showInput = _this$props.showInput,
inputPopoverProps = _this$props.inputPopoverProps,
showTicks = _this$props.showTicks,
tickInterval = _this$props.tickInterval,
ticks = _this$props.ticks,
levels = _this$props.levels,
showRange = _this$props.showRange,
showValue = _this$props.showValue,
valueAppend = _this$props.valueAppend,
valuePrepend = _this$props.valuePrepend,
onBlur = _this$props.onBlur,
onChange = _this$props.onChange,
onFocus = _this$props.onFocus,
value = _this$props.value,
tabIndex = _this$props.tabIndex,
isInvalid = _this$props.isInvalid,
theme = _this$props.theme,
rest = _objectWithoutProperties(_this$props, _excluded);
var id = this.state.id;
var showInputOnly = showInput === 'inputWithPopover';
var canShowDropdown = showInputOnly && !readOnly && !disabled;
var theInput = !!showInput ? ___EmotionJSX(EuiRangeInput, _extends({
id: id,
min: min,
max: max,
step: step,
value: value,
readOnly: readOnly,
disabled: disabled,
compressed: compressed,
onChange: this.handleOnChange,
name: name,
onFocus: canShowDropdown ? this.onInputFocus : onFocus,
onBlur: canShowDropdown ? this.onInputBlur : onBlur,
fullWidth: showInputOnly && fullWidth,
isLoading: showInputOnly && isLoading,
isInvalid: isInvalid,
autoSize: !showInputOnly
}, rest)) : null;
var classes = classNames('euiRange', className);
var styles = euiRangeStyles(theme);
var cssStyles = [styles.euiRange, showInput && styles.hasInput];
var thumbColor = levels && getLevelColor(levels, Number(value));
var sliderScreenReaderInstructions = ___EmotionJSX(EuiI18n, {
token: "euiRange.sliderScreenReaderInstructions",
default: "You are in a custom range slider. Use the Up and Down arrow keys to change the value."
});
var theRange = ___EmotionJSX(EuiRangeWrapper, {
className: classes,
css: cssStyles,
fullWidth: fullWidth,
compressed: compressed
}, showLabels && ___EmotionJSX(EuiRangeLabel, {
side: "min",
disabled: disabled
}, min), ___EmotionJSX(EuiRangeTrack, {
trackWidth: this.state.trackWidth,
disabled: disabled,
compressed: compressed,
max: max,
min: min,
step: step,
showTicks: showTicks,
tickInterval: tickInterval,
ticks: ticks,
levels: levels,
onChange: this.handleOnChange,
value: value,
"aria-hidden": !!showInput,
showRange: showRange
}, ___EmotionJSX(EuiRangeSlider, _extends({
ariaValueText: ticks ? this.handleAriaValueText(ticks, value) : undefined,
id: showInput ? undefined : id // Attach id only to the input if there is one
,
name: name,
min: min,
max: max,
step: step,
value: value,
disabled: disabled,
onChange: this.handleOnChange,
showTicks: showTicks,
showRange: showRange,
tabIndex: showInput ? -1 : tabIndex,
onMouseDown: showInputOnly ? function () {
return _this2.preventPopoverClose = true;
} : undefined,
onFocus: showInput === true ? undefined : onFocus,
onBlur: showInputOnly ? this.onInputBlur : onBlur,
"aria-hidden": !!showInput,
thumbColor: thumbColor
}, rest, {
onResize: this.setTrackWidth
})), showRange && this.isValid && ___EmotionJSX(EuiRangeHighlight, {
showTicks: showTicks,
min: Number(min),
max: Number(max),
lowerValue: Number(min),
upperValue: Number(value),
levels: levels,
trackWidth: this.state.trackWidth
}), showValue && !!String(value).length && ___EmotionJSX(EuiRangeTooltip, {
value: value,
max: max,
min: min,
name: name,
showTicks: showTicks,
valuePrepend: valuePrepend,
valueAppend: valueAppend
})), showLabels && ___EmotionJSX(EuiRangeLabel, {
side: "max",
disabled: disabled
}, max), showInput && !showInputOnly && ___EmotionJSX(React.Fragment, null, ___EmotionJSX("div", {
className: showTicks || ticks ? 'euiRange__slimHorizontalSpacer' : 'euiRange__horizontalSpacer',
css: showTicks || ticks ? styles.euiRange__slimHorizontalSpacer : styles.euiRange__horizontalSpacer
}), theInput));
var thePopover = showInputOnly ? ___EmotionJSX(EuiInputPopover, _extends({}, inputPopoverProps, {
className: classNames('euiRange__popover', inputPopoverProps === null || inputPopoverProps === void 0 ? void 0 : inputPopoverProps.className),
input: theInput // `showInputOnly` confirms existence
,
fullWidth: fullWidth,
isOpen: this.state.isPopoverOpen,
closePopover: this.closePopover,
disableFocusTrap: true,
popoverScreenReaderText: sliderScreenReaderInstructions
}), theRange) : undefined;
return thePopover ? thePopover : theRange;
}
}]);
}(Component);
_defineProperty(EuiRangeClass, "contextType", FormContext);
_defineProperty(EuiRangeClass, "defaultProps", {
min: 0,
max: 100,
step: 1,
compressed: false,
isLoading: false,
showLabels: false,
showInput: false,
showRange: false,
showTicks: false,
showValue: false,
levels: []
});
EuiRangeClass.propTypes = {
/**
* Shows a tooltip styled value
*/
showValue: PropTypes.bool,
/**
* Appends to the tooltip
*/
valueAppend: PropTypes.node,
/**
* Prepends to the tooltip
*/
valuePrepend: PropTypes.node,
/**
* Only impacts the input rendered by the `showInput` prop.
* `string` | `ReactElement` or an array of these
*/
prepend: PropTypes.oneOfType([PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.element.isRequired]).isRequired, PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.element.isRequired]).isRequired).isRequired]),
/**
* Only impacts the input rendered by the `showInput` prop.
* `string` | `ReactElement` or an array of these
*/
append: PropTypes.oneOfType([PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.element.isRequired]).isRequired, PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.element.isRequired]).isRequired).isRequired]),
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any,
value: PropTypes.oneOfType([PropTypes.string.isRequired, PropTypes.number.isRequired]).isRequired,
onChange: PropTypes.func,
max: PropTypes.number.isRequired,
min: PropTypes.number.isRequired,
/**
* The number to increment or decrement between each interval
* @default 1
*/
step: PropTypes.number,
/**
* Specified ticks at specified values
*/
ticks: PropTypes.arrayOf(PropTypes.shape({
value: PropTypes.number.isRequired,
label: PropTypes.node.isRequired,
accessibleLabel: PropTypes.string
}).isRequired),
/**
* Modifies the number of tick marks and at what interval
*/
tickInterval: PropTypes.number,
/**
* Create colored indicators for certain intervals.
* An array of #EuiRangeLevel objects
*/
levels: PropTypes.arrayOf(PropTypes.shape({
/**
* Accepts one of `["primary", "success", "warning", "danger"]` or a valid CSS color value.
*/
color: PropTypes.oneOfType([PropTypes.any.isRequired, PropTypes.any.isRequired]).isRequired,
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any
}).isRequired),
/**
* Pass `true` to displays an extra input control for direct manipulation.
* Pass `"inputWithPopover"` to only show the input but show the range in a dropdown.
*/
showInput: PropTypes.oneOfType([PropTypes.bool.isRequired, PropTypes.oneOf(["inputWithPopover"])]),
/**
* Shows static min/max labels on the sides of the range slider
*/
showLabels: PropTypes.bool,
/**
* Shows a thick line from min to value
*/
showRange: PropTypes.bool,
/**
* Shows clickable tick marks and labels at the given interval (`step`/`tickInterval`)
*/
showTicks: PropTypes.bool,
id: PropTypes.string,
name: PropTypes.string,
/**
* Only impacts ticks rendered by `showTicks` or inputs rendered by `showInput`.
*/
compressed: PropTypes.bool,
/**
* Only impacts inputs rendered by the `showInput` prop.
* The range slider itself remains interactable unless `disabled` is applied.
*/
readOnly: PropTypes.bool,
/**
* Disables both the range track and any input(s)
*/
disabled: PropTypes.bool,
/**
* Expand to fill 100% of the parent.
* Defaults to `fullWidth` prop of `<EuiForm>`.
* @default false
*/
fullWidth: PropTypes.bool,
/**
* Only impacts inputs rendered by the `showInput` prop
*/
isInvalid: PropTypes.bool,
/**
* Only impacts inputs rendered when the `showInput` prop is set to `"inputWithPopover"`
*/
isLoading: PropTypes.bool,
/**
* Only impacts input popovers rendered when the `showInput` prop is set to `"inputWithPopover"`
*
* Allows customizing the underlying [EuiInputPopover](/#/layout/popover#popover-attached-to-input-element),
* except for props controlled by the range component
*/
inputPopoverProps: PropTypes.shape({
className: PropTypes.string,
"aria-label": PropTypes.string,
"data-test-subj": PropTypes.string,
css: PropTypes.any,
/**
* Alignment of the popover relative to the input
*/
anchorPosition: PropTypes.oneOf(["downLeft", "downRight", "downCenter"]),
/**
* Allows automatically closing the input popover on page scroll
*/
closeOnScroll: PropTypes.bool,
inputRef: PropTypes.any,
onPanelResize: PropTypes.func,
/**
* By default, **EuiInputPopovers** inherit the same width as the passed input element.
* However, if the input width is too small, you can pass a minimum panel width
* (that should be based on the popover content).
*/
panelMinWidth: PropTypes.number
})
};
export var EuiRange = withEuiTheme(EuiRangeClass);