/* * Copyright 2018 Palantir Technologies, Inc. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import classNames from "classnames"; import * as React from "react"; import { polyfill } from "react-lifecycles-compat"; import { AbstractPureComponent2, Classes, Intent } from "../../common"; import * as Errors from "../../common/errors"; import { DISPLAYNAME_PREFIX, IntentProps, Props } from "../../common/props"; import * as Utils from "../../common/utils"; import { Handle } from "./handle"; import { HandleInteractionKind, HandleType, HandleProps } from "./handleProps"; import { argMin, fillValues, formatPercentage } from "./sliderUtils"; /** * SFC used to pass slider handle props to a `MultiSlider`. * This element is not rendered directly. */ const MultiSliderHandle: React.FunctionComponent = () => null; MultiSliderHandle.displayName = `${DISPLAYNAME_PREFIX}.MultiSliderHandle`; export interface ISliderBaseProps extends Props, IntentProps { /** * Whether the slider is non-interactive. * * @default false */ disabled?: boolean; /** * Increment between successive labels. Must be greater than zero. * * @default inferred (if labelStepSize is undefined) */ labelStepSize?: number; /** * Array of specific values for the label placement. This prop is mutually exclusive with * `labelStepSize`. */ labelValues?: number[]; /** * Number of decimal places to use when rendering label value. Default value is the number of * decimals used in the `stepSize` prop. This prop has _no effect_ if you supply a custom * `labelRenderer` callback. * * @default inferred from stepSize */ labelPrecision?: number; /** * Maximum value of the slider. * * @default 10 */ max?: number; /** * Minimum value of the slider. * * @default 0 */ min?: number; /** * Whether a solid bar should be rendered on the track between current and initial values, * or between handles for `RangeSlider`. * * @default true */ showTrackFill?: boolean; /** * Increment between successive values; amount by which the handle moves. Must be greater than zero. * * @default 1 */ stepSize?: number; /** * Callback to render a single label. Useful for formatting numbers as currency or percentages. * If `true`, labels will use number value formatted to `labelPrecision` decimal places. * If `false`, labels will not be shown. * * The callback is provided a numeric value and optional rendering options, which include: * - isHandleTooltip: whether this label is being rendered within a handle tooltip * * @default true */ labelRenderer?: boolean | ((value: number, opts?: { isHandleTooltip: boolean }) => string | JSX.Element); /** * Whether to show the slider in a vertical orientation. * * @default false */ vertical?: boolean; } // eslint-disable-next-line deprecation/deprecation export type MultiSliderProps = IMultiSliderProps; /** @deprecated use MultiSliderProps */ export interface IMultiSliderProps extends ISliderBaseProps { /** Default intent of a track segment, used only if no handle specifies `intentBefore/After`. */ defaultTrackIntent?: Intent; /** Callback invoked when a handle value changes. Receives handle values in sorted order. */ onChange?(values: number[]): void; /** Callback invoked when a handle is released. Receives handle values in sorted order. */ onRelease?(values: number[]): void; } export interface ISliderState { labelPrecision: number; /** the client size, in pixels, of one tick */ tickSize: number; /** the size of one tick as a ratio of the component's client size */ tickSizeRatio: number; } @polyfill export class MultiSlider extends AbstractPureComponent2 { public static defaultSliderProps: ISliderBaseProps = { disabled: false, max: 10, min: 0, showTrackFill: true, stepSize: 1, vertical: false, }; public static defaultProps: MultiSliderProps = { ...MultiSlider.defaultSliderProps, defaultTrackIntent: Intent.NONE, }; public static displayName = `${DISPLAYNAME_PREFIX}.MultiSlider`; public static Handle = MultiSliderHandle; public static getDerivedStateFromProps(props: MultiSliderProps) { return { labelPrecision: MultiSlider.getLabelPrecision(props) }; } private static getLabelPrecision({ labelPrecision, stepSize }: MultiSliderProps) { // infer default label precision from stepSize because that's how much the handle moves. return labelPrecision == null ? Utils.countDecimalPlaces(stepSize!) : labelPrecision; } public state: ISliderState = { labelPrecision: getLabelPrecision(this.props), tickSize: 0, tickSizeRatio: 0, }; private handleElements: Handle[] = []; private trackElement: HTMLElement | null = null; public getSnapshotBeforeUpdate(prevProps: MultiSliderProps): null { const prevHandleProps = getSortedInteractiveHandleProps(prevProps); const newHandleProps = getSortedInteractiveHandleProps(this.props); if (newHandleProps.length !== prevHandleProps.length) { // clear refs this.handleElements = []; } return null; } public render() { const classes = classNames( Classes.SLIDER, { [Classes.DISABLED]: this.props.disabled, [`${Classes.SLIDER}-unlabeled`]: this.props.labelRenderer === false, [Classes.VERTICAL]: this.props.vertical, }, this.props.className, ); return (
(this.trackElement = ref)}> {this.renderTracks()}
{this.renderLabels()}
{this.renderHandles()}
); } public componentDidMount() { this.updateTickSize(); } public componentDidUpdate(prevProps: MultiSliderProps, prevState: ISliderState) { super.componentDidUpdate(prevProps, prevState); this.updateTickSize(); } protected validateProps(props: React.PropsWithChildren) { if (props.stepSize! <= 0) { throw new Error(Errors.SLIDER_ZERO_STEP); } if (props.labelStepSize !== undefined && props.labelValues !== undefined) { throw new Error(Errors.MULTISLIDER_WARN_LABEL_STEP_SIZE_LABEL_VALUES_MUTEX); } if (props.labelStepSize !== undefined && props.labelStepSize! <= 0) { throw new Error(Errors.SLIDER_ZERO_LABEL_STEP); } let anyInvalidChildren = false; React.Children.forEach(props.children, child => { // allow boolean coercion to omit nulls and false values if (child && !Utils.isElementOfType(child, MultiSlider.Handle)) { anyInvalidChildren = true; } }); if (anyInvalidChildren) { throw new Error(Errors.MULTISLIDER_INVALID_CHILD); } } private formatLabel(value: number, isHandleTooltip: boolean = false) { const { labelRenderer } = this.props; if (labelRenderer === false) { return undefined; } else if (Utils.isFunction(labelRenderer)) { return labelRenderer(value, { isHandleTooltip }); } else { return value.toFixed(this.state.labelPrecision); } } private renderLabels() { if (this.props.labelRenderer === false) { return null; } const values = this.getLabelValues(); const { max, min } = this.props; const labels = values.map((step, i) => { const offsetPercentage = formatPercentage((step - min!) / (max! - min!)); const style = this.props.vertical ? { bottom: offsetPercentage } : { left: offsetPercentage }; return (
{this.formatLabel(step)}
); }); return labels; } private renderTracks() { const trackStops = getSortedHandleProps(this.props); trackStops.push({ value: this.props.max! }); // render from current to previous, then increment previous let previous: HandleProps = { value: this.props.min! }; const handles: JSX.Element[] = []; for (let index = 0; index < trackStops.length; index++) { const current = trackStops[index]; handles.push(this.renderTrackFill(index, previous, current)); previous = current; } return handles; } private renderTrackFill(index: number, start: HandleProps, end: HandleProps) { // ensure startRatio <= endRatio const [startRatio, endRatio] = [this.getOffsetRatio(start.value), this.getOffsetRatio(end.value)].sort( (left, right) => left - right, ); const startOffset = formatPercentage(startRatio); const endOffset = formatPercentage(1 - endRatio); const orientationStyle: React.CSSProperties = this.props.vertical ? { bottom: startOffset, top: endOffset, left: 0 } : { left: startOffset, right: endOffset, top: 0 }; const style: React.CSSProperties = { ...orientationStyle, ...(start.trackStyleAfter || end.trackStyleBefore || {}), }; const classes = classNames(Classes.SLIDER_PROGRESS, Classes.intentClass(this.getTrackIntent(start, end))); return
; } private renderHandles() { const { disabled, max, min, stepSize, vertical } = this.props; const handleProps = getSortedInteractiveHandleProps(this.props); if (handleProps.length === 0) { return null; } return handleProps.map(({ value, type, className }, index) => ( )); } private addHandleRef = (ref: Handle) => { if (ref != null) { this.handleElements.push(ref); } }; private maybeHandleTrackClick = (event: React.MouseEvent) => { if (this.canHandleTrackEvent(event)) { const foundHandle = this.nearestHandleForValue(this.handleElements, handle => handle.mouseEventClientOffset(event), ); if (foundHandle) { foundHandle.beginHandleMovement(event); } } }; private maybeHandleTrackTouch = (event: React.TouchEvent) => { if (this.canHandleTrackEvent(event)) { const foundHandle = this.nearestHandleForValue(this.handleElements, handle => handle.touchEventClientOffset(event), ); if (foundHandle) { foundHandle.beginHandleTouchMovement(event); } } }; private canHandleTrackEvent = (event: React.MouseEvent | React.TouchEvent) => { const target = event.target as HTMLElement; // ensure event does not come from inside the handle return !this.props.disabled && target.closest(`.${Classes.SLIDER_HANDLE}`) == null; }; private nearestHandleForValue(handles: Handle[], getOffset: (handle: Handle) => number): Handle | undefined { return argMin(handles, handle => { const offset = getOffset(handle); const offsetValue = handle.clientToValue(offset); const handleValue = handle.props.value!; return Math.abs(offsetValue - handleValue); }); } private getHandlerForIndex = (index: number, callback?: (values: number[]) => void) => { return (newValue: number) => { callback?.(this.getNewHandleValues(newValue, index)); }; }; private getNewHandleValues(newValue: number, oldIndex: number) { const handleProps = getSortedInteractiveHandleProps(this.props); const oldValues = handleProps.map(handle => handle.value); const newValues = oldValues.slice(); newValues[oldIndex] = newValue; newValues.sort((left, right) => left - right); const newIndex = newValues.indexOf(newValue); const lockIndex = this.findFirstLockedHandleIndex(oldIndex, newIndex); if (lockIndex === -1) { fillValues(newValues, oldIndex, newIndex, newValue); } else { // If pushing past a locked handle, discard the new value and only make the updates to clamp values against the lock. const lockValue = oldValues[lockIndex]; fillValues(oldValues, oldIndex, lockIndex, lockValue); return oldValues; } return newValues; } private findFirstLockedHandleIndex(startIndex: number, endIndex: number): number { const inc = startIndex < endIndex ? 1 : -1; const handleProps = getSortedInteractiveHandleProps(this.props); for (let index = startIndex + inc; index !== endIndex + inc; index += inc) { if (handleProps[index].interactionKind !== HandleInteractionKind.PUSH) { return index; } } return -1; } private handleChange = (newValues: number[]) => { const handleProps = getSortedInteractiveHandleProps(this.props); const oldValues = handleProps.map(handle => handle.value); if (!Utils.arraysEqual(newValues, oldValues)) { this.props.onChange?.(newValues); handleProps.forEach((handle, index) => { if (oldValues[index] !== newValues[index]) { handle.onChange?.(newValues[index]); } }); } }; private handleRelease = (newValues: number[]) => { const handleProps = getSortedInteractiveHandleProps(this.props); this.props.onRelease?.(newValues); handleProps.forEach((handle, index) => { handle.onRelease?.(newValues[index]); }); }; private getLabelValues() { const { labelStepSize, labelValues, min, max } = this.props; let values: number[] = []; if (labelValues !== undefined) { values = labelValues; } else { for (let i = min!; i < max! || Utils.approxEqual(i, max!); i += labelStepSize ?? 1) { values.push(i); } } return values; } private getOffsetRatio(value: number) { return Utils.clamp((value - this.props.min!) * this.state.tickSizeRatio, 0, 1); } private getTrackIntent(start: HandleProps, end?: HandleProps): Intent { if (!this.props.showTrackFill) { return Intent.NONE; } if (start.intentAfter !== undefined) { return start.intentAfter; } else if (end !== undefined && end.intentBefore !== undefined) { return end.intentBefore; } return this.props.defaultTrackIntent!; } private updateTickSize() { if (this.trackElement != null) { const trackSize = this.props.vertical ? this.trackElement.clientHeight : this.trackElement.clientWidth; const tickSizeRatio = 1 / ((this.props.max as number) - (this.props.min as number)); const tickSize = trackSize * tickSizeRatio; this.setState({ tickSize, tickSizeRatio }); } } } function getLabelPrecision({ labelPrecision, stepSize = MultiSlider.defaultSliderProps.stepSize! }: MultiSliderProps) { // infer default label precision from stepSize because that's how much the handle moves. return labelPrecision == null ? Utils.countDecimalPlaces(stepSize) : labelPrecision; } function getSortedInteractiveHandleProps(props: React.PropsWithChildren): HandleProps[] { return getSortedHandleProps(props, childProps => childProps.interactionKind !== HandleInteractionKind.NONE); } function getSortedHandleProps( { children }: React.PropsWithChildren, predicate: (props: HandleProps) => boolean = () => true, ) { const maybeHandles = React.Children.map(children, child => Utils.isElementOfType(child, MultiSlider.Handle) && predicate(child.props) ? child.props : null, ); let handles = maybeHandles != null ? maybeHandles : []; handles = handles.filter(handle => handle !== null); handles.sort((left, right) => left.value - right.value); return handles; }