@arco-design/mobile-react 2.31.5 → 2.32.0

package/esnext/slider/hooks/useSliderInit.js

@@ -0,0 +1,146 @@
+import React, { useState, useEffect, useMemo, useContext, useCallback } from 'react';
+import { SliderContext } from '.';
+export const useSliderInit = ({ commonIsTouching }) => {
+    const ctx = useContext(SliderContext);
+    const { value, min, max, onAfterChange, onChange, useMarkOnly, marks, useRange } = ctx;
+    const baseValue = ctx?.value ?? ctx?.defaultValue ?? min;
+    const [valueGroup, setValueGroup] = useState(baseValue);
+    const [firstRender, setFirstRender] = useState(false);
+    const [firstTouch, setFirstTouch] = useState(false);
+    // 基础标签数组
+    // @en Base mark list
+    const baseConfig = useMemo(() => {
+        if (marks === void 0)
+            return [];
+        let res = [];
+        if (typeof marks === 'number') {
+            res = Array((max - min) / marks + 1)
+                .fill('')
+                .map((_, idx) => idx * marks);
+        }
+        else if (Array.isArray(marks)) {
+            res = marks;
+        }
+        else {
+            res = Object.keys(marks).map(e => parseInt(e));
+        }
+        return [...res].filter(e => e <= max && e >= min).sort((a, b) => (a > b ? 1 : -1));
+    }, [marks, max, min]);
+    const validate = useCallback((newValue) => {
+        if (typeof valueGroup === 'number')
+            return newValue <= valueGroup;
+        const [small, large] = [...valueGroup].sort((a, b) => (a > b ? 1 : -1));
+        return newValue >= small && newValue <= large;
+    }, [valueGroup]);
+    // 实际 mark 标签
+    // @en Actual mark tags
+    const runTimeConfig = useMemo(() => {
+        return baseConfig.map(e => {
+            const label = marks && !Array.isArray(marks) && marks[String(e)] && typeof marks !== 'number' ? (marks[String(e)]) : (React.createElement("p", null, e));
+            return {
+                activated: validate(e),
+                value: e,
+                label,
+            };
+        });
+    }, [baseConfig, valueGroup, validate, marks]);
+    // 当前值最近的标签值
+    // @en The mark value closest to the current value
+    const formatMarksValue = useCallback((newValue) => {
+        if (!useMarkOnly || marks === void 0)
+            return newValue;
+        const format = (v) => {
+            let idx;
+            baseConfig.forEach((e, i) => {
+                if (v >= e) {
+                    idx = i;
+                }
+            });
+            if (idx !== void 0) {
+                const largerIdx = idx + 1;
+                if (largerIdx < baseConfig.length &&
+                    Math.abs(baseConfig[largerIdx] - v) < Math.abs(baseConfig[idx] - v)) {
+                    return baseConfig[largerIdx];
+                }
+                return baseConfig[idx];
+            }
+            return baseConfig[0];
+        };
+        if (typeof newValue === 'number')
+            return format(newValue);
+        return newValue.map(v => format(v));
+    }, [useMarkOnly, marks, baseConfig]);
+    /**
+     * 标记第一次渲染，方便获取位置
+     * @en Mark the first render for easy location
+     */
+    useEffect(() => {
+        if (commonIsTouching)
+            setFirstTouch(true);
+    }, [commonIsTouching]);
+    /**
+     * 是否为 range，多个游标
+     * @en Whether it is range, multiple cursors
+     */
+    const isMultiThumb = useMemo(() => useRange || Array.isArray(baseValue), [useRange, typeof baseValue === 'number']);
+    /**
+     * 为 range 组件初始化数据
+     * @en Initialize data for the range component
+     */
+    useEffect(() => {
+        setFirstRender(true);
+        /**
+         * 初始化数据
+         * @en Initialize data
+         */
+        const newValue = isMultiThumb && typeof valueGroup === 'number'
+            ? formatMarksValue([valueGroup, valueGroup])
+            : formatMarksValue(valueGroup);
+        setValueGroup(newValue);
+    }, [isMultiThumb]);
+    /**
+     * 监听数据 value 变化
+     * @en Monitor data value changes
+     */
+    useEffect(() => {
+        if (value === void 0 || !firstRender || commonIsTouching !== -1)
+            return;
+        const newValue = isMultiThumb && typeof value === 'number'
+            ? formatMarksValue([value, value])
+            : formatMarksValue(value);
+        setValueGroup(newValue);
+        // 如果受控需要还原
+        // @en If controlled, it needs to restore
+    }, [firstRender && value, commonIsTouching]);
+    /**
+     * 上报排序后的值
+     * @en report sorted value
+     */
+    const formatValueGroup = useMemo(() => typeof valueGroup === 'number'
+        ? valueGroup
+        : [...valueGroup].sort((a, b) => (a > b ? 1 : -1)), [valueGroup]);
+    useEffect(() => {
+        if (!firstTouch)
+            return;
+        if (commonIsTouching > -1)
+            onChange(formatValueGroup);
+    }, [valueGroup]);
+    useEffect(() => {
+        if (!firstTouch)
+            return;
+        if (commonIsTouching === -1) {
+            onAfterChange(formatMarksValue(formatValueGroup));
+            if (value === void 0) {
+                const newValue = formatMarksValue(valueGroup);
+                setValueGroup(newValue);
+            }
+        }
+    }, [commonIsTouching, formatMarksValue]);
+    return {
+        valueGroup,
+        setValueGroup,
+        firstRender,
+        runTimeConfig,
+        isMultiThumb,
+    };
+};

package/esnext/slider/hooks/useSliderStyle.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties } from 'react';
+import { LinePosition } from '.';
+export declare const useSliderStyle: ({ getLinePosition, commonIsTouching, valueGroup, }: {
+    commonIsTouching: number;
+    getLinePosition: () => LinePosition;
+    valueGroup: number | [number, number];
+}) => {
+    heightStyle: {
+        [x: string]: string;
+    };
+    transitionClass: string;
+    activeLineStyle: CSSProperties;
+};

package/esnext/slider/hooks/useSliderStyle.js

@@ -0,0 +1,39 @@
+import { useContext, useMemo } from 'react';
+import { SliderContext } from '.';
+import { GlobalContext } from '../../context-provider';
+export const useSliderStyle = ({ getLinePosition, commonIsTouching, valueGroup, }) => {
+    const { useRtl } = useContext(GlobalContext);
+    const { size, useAnimation, min, max, type } = useContext(SliderContext);
+    const isHorizontal = /^horizontal/g.test(type);
+    const heightStyle = useMemo(() => {
+        if (size === void 0)
+            return {};
+        const sizeCount = typeof size === 'string' ? parseInt(size) : size;
+        return { [isHorizontal ? 'height' : 'width']: `${sizeCount}px` };
+    }, [size, isHorizontal]);
+    const transitionClass = useMemo(() => {
+        return useAnimation && commonIsTouching === -1 ? 'is-transferable' : '';
+    }, [commonIsTouching, useAnimation]);
+    const activeLineStyle = useMemo(() => {
+        let { length } = getLinePosition();
+        let start = 0;
+        if (typeof valueGroup === 'number') {
+            length *= (valueGroup - min) / (max - min);
+        }
+        else {
+            const [smaller, larger] = [...valueGroup].sort((a, b) => (a > b ? 1 : -1));
+            start = ((smaller - min) / (max - min)) * length;
+            length = ((larger - min) / (max - min)) * length - start;
+        }
+        const leftStyle = useRtl ? 'right' : 'left';
+        return {
+            [isHorizontal ? leftStyle : 'bottom']: `${start}px`,
+            [isHorizontal ? 'width' : 'height']: `${Math.abs(length)}px`,
+        };
+    }, [valueGroup, getLinePosition, min, max, isHorizontal]);
+    return {
+        heightStyle,
+        transitionClass,
+        activeLineStyle,
+    };
+};

package/esnext/slider/index.d.ts

@@ -0,0 +1,163 @@
+import React, { ReactNode } from 'react';
+export interface SliderProps {
+    /**
+     * 自定义类名
+     * @en Custom classname
+     * @default ""
+     */
+    className?: string;
+    /**
+     * 自定义样式
+     * @en Custom stylesheet
+     * @default {}
+     */
+    style?: React.CSSProperties;
+    /**
+     * 是否禁用
+     * @en Disabled
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * 使用范围选择
+     * @en Use range selection
+     * @default 根据 传入初始参数判断，没有则为 false
+     * @default_en Judging by the incoming initial parameters, false if not
+     */
+    useRange?: boolean;
+    /**
+     * 非点击状态使用动画
+     * @en Use animation for non-click state
+     * @default true
+     */
+    useAnimation?: boolean;
+    /**
+     * 最小值
+     * @en Minimum value
+     * @default 0
+     */
+    min?: number;
+    /**
+     * 最大值
+     * @en Maximum value
+     * @default 100
+     */
+    max?: number;
+    /**
+     * 默认初始值
+     * @en Default initial value
+     */
+    defaultValue?: number | [number, number];
+    /**
+     * 基础值，组件受控
+     * @en Value, component will be controlled
+     */
+    value?: number | [number, number];
+    /**
+     * 最小单位
+     * @en Step
+     * @default 1
+     */
+    step?: number;
+    /**
+     * 组件方向
+     * @en Component direction
+     * @default "horizontal"
+     */
+    type?: 'horizontal' | 'vertical';
+    /**
+     * 是否展示气泡
+     * @en Whether to show tooltips
+     * @default "auto"
+     */
+    showTooltip?: 'auto' | 'always' | 'never';
+    /**
+     * 滑动条节点配置
+     * @en Slider node configuration
+     */
+    marks?: number | number[] | Record<string, ReactNode>;
+    /**
+     * 是否展示标签底部文案
+     * @en Whether to display the bottom mark text
+     * @default false
+     */
+    showMarks?: boolean;
+    /**
+     * 是否只可用标志的值，覆盖 step
+     * @en Whether only the value of the mark is available, overriding step
+     * @default false
+     */
+    useMarkOnly?: boolean;
+    /**
+     * 前缀 icon 或者 文案
+     * @en prefix icon or label
+     */
+    prefixLabel?: boolean | ((value: number | [number, number]) => ReactNode) | ReactNode;
+    /**
+     * 后缀 icon 或者 文案
+     * @en Suffix icon or label
+     */
+    suffixLabel?: boolean | ((value: number | [number, number]) => ReactNode) | ReactNode;
+    /**
+     * 组件横条粗细，单位 px
+     * @en Slider bar thickness (unit: px)
+     * @default 2
+     */
+    size?: number | string;
+    /**
+     * 只允许拖动滑块 默认 false
+     * @en Only allow dragging of sliders,  the default is false
+     * @default false
+     */
+    draggableTrackOnly?: boolean;
+    /**
+     * 自定义气泡内容
+     * @en Custom tooltip content
+     */
+    formatTooltip?: (value: number) => string | ReactNode;
+    /**
+     * 修改后事件，时机同 touchend
+     * @en Callback after value changes, the timing is the same as touchend
+     */
+    onAfterChange?: (value: number | [number, number]) => void;
+    /**
+     * 实时修改事件
+     * @en Callback when value changes in real time
+     */
+    onChange?: (value: number | [number, number]) => void;
+    /**
+     * 自定义滑块
+     * @en Custom slider
+     */
+    renderThumb?: (value: number) => ReactNode;
+    /**
+     * 自定义滑块的Popover，优先级高于formatTooltip。value表示当前滑动进度，visible表示气泡的可见性，index表示当前滑块索引，thumbEl表示当前滑块元素。
+     * @en Custom slider popover，priority is higher than formatTooltip. value - current sliding progress, visible - visibility of the bubble, index - current slider index, thumbEl - current slider element.
+     */
+    renderThumbPopover?: (config: {
+        value: number;
+        visible: boolean;
+        index: number;
+        thumbEl: React.ReactNode;
+    }) => ReactNode;
+}
+export interface SliderRef {
+    /**
+     * 最外层元素 DOM
+     * @en The outermost element DOM
+     */
+    dom: HTMLDivElement | null;
+}
+declare const _default: React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<SliderRef>> & {
+    displayName?: string | undefined;
+};
+/**
+ * 滑动型输入器，展示当前值和可选范围。
+ * @en Slide input component, displays the current value and optional range.
+ * @name 滑动输入条
+ * @name_en Slider
+ * @type 数据录入
+ * @type_en Data Entry
+ * @displayName Slider
+ */
+export default _default;

package/esnext/slider/index.js

@@ -0,0 +1,120 @@
+import React, { useRef, forwardRef, useImperativeHandle, useContext, useState, useMemo, useCallback, } from 'react';
+import { cls, componentWrapper } from '@arco-design/mobile-utils';
+import { GlobalContext } from '../context-provider';
+import { useSliderStyle, useSliderIcon, SliderContext, baseRenderThumb, useSliderInit, useSliderEvents, } from './hooks';
+import Thumb from './thumb';
+import Marks from './marks';
+const Slider = forwardRef((_, ref) => {
+    const { prefixCls = '', useRtl } = useContext(GlobalContext);
+    const { className, style, disabled, min, max, type, showTooltip, showMarks } = useContext(SliderContext);
+    const domRef = useRef(null);
+    const lineRef = useRef(null);
+    // 拖动滑块的 index 为当前的 isTouching
+    // @en The index of the slider is the current isTouching
+    const [commonIsTouching, setCommonIsTouching] = useState(-1);
+    const isHorizontal = /^horizontal/g.test(type);
+    useImperativeHandle(ref, () => ({
+        dom: domRef.current,
+    }));
+    const { firstRender, valueGroup, setValueGroup, runTimeConfig, isMultiThumb } = useSliderInit({
+        commonIsTouching,
+    });
+    // 最长线 div 位置
+    const getLinePosition = useCallback(() => {
+        const { width, left, top, height } = lineRef.current?.getBoundingClientRect() ?? {
+            width: 0,
+            left: 0,
+            top: 0,
+            height: 0,
+        };
+        const leftValue = useRtl ? left + width : left;
+        return {
+            length: isHorizontal ? width : height,
+            start: isHorizontal ? leftValue : top,
+        };
+    }, [isHorizontal, firstRender]);
+    const { heightStyle, transitionClass, activeLineStyle } = useSliderStyle({
+        getLinePosition,
+        commonIsTouching,
+        valueGroup,
+    });
+    useSliderEvents({
+        lineRef,
+        valueGroup,
+        setValueGroup,
+        getLinePosition,
+        setCommonIsTouching,
+    });
+    const { renderPrefixLabel, renderSuffixLabel } = useSliderIcon({ valueGroup });
+    /**
+     * 为了减少 dom 元素计算，只改变激活 line 的样式，让对应的 thumb 附着在两边，所以需要实时调整 className
+     * @en In order to reduce the calculation of dom elements, only the style of the active line is changed, so that the corresponding thumb is attached to both sides, so the className needs to be adjusted in real time
+     */
+    const thumbConfig = useMemo(() => {
+        if (isMultiThumb) {
+            const classNames = ['is-end', 'is-start'];
+            return Array(2)
+                .fill('')
+                .map((_, index) => {
+                let childClassName = classNames[index];
+                if (valueGroup[index] > valueGroup[1 - index]) {
+                    [childClassName] = classNames;
+                }
+                else if (valueGroup[index] < valueGroup[1 - index]) {
+                    [, childClassName] = classNames;
+                }
+                return {
+                    className: childClassName,
+                };
+            });
+        }
+        return [
+            {
+                className: 'is-end',
+            },
+        ];
+        /**
+         * 只有 range 状态才监听 valueGroup
+         * @en Only listen to valueGroup in the range state
+         */
+    }, [isMultiThumb && valueGroup]);
+    return (React.createElement("div", { className: cls(`${prefixCls}-slider ${className}`, `is-${type}`, {
+            'is-disabled': disabled,
+            'show-tooltip': showTooltip !== 'never' && !disabled,
+            'show-marks': showMarks,
+        }), style: style, ref: domRef, role: "slider", "aria-valuemin": min, "aria-valuemax": max, "aria-valuenow": Array.isArray(valueGroup) ? valueGroup[0] : valueGroup, "aria-disabled": disabled },
+        isHorizontal ? renderPrefixLabel : renderSuffixLabel,
+        React.createElement("div", { className: `${prefixCls}-slider-wrapper` },
+            React.createElement(Marks, { runTimeConfig: runTimeConfig, className: transitionClass }),
+            React.createElement("div", { className: `${prefixCls}-slider-line`, style: heightStyle, ref: lineRef },
+                React.createElement("div", { className: `${prefixCls}-slider-line is-activated ${transitionClass}`, style: { ...heightStyle, ...activeLineStyle } }, thumbConfig.map((cfg, idx) => (React.createElement(Thumb, Object.assign({ key: idx }, {
+                    value: Array.isArray(valueGroup) ? valueGroup[idx] : valueGroup,
+                    idx,
+                    min,
+                    max,
+                    isTouching: commonIsTouching === idx,
+                    ...cfg,
+                }))))))),
+        isHorizontal ? renderSuffixLabel : renderPrefixLabel));
+});
+const SliderWrapper = forwardRef((props, ref) => {
+    const { prefixCls = '' } = useContext(GlobalContext);
+    const defaultProps = useContext(SliderContext);
+    const newProps = {
+        ...defaultProps,
+        renderThumb: baseRenderThumb(prefixCls),
+        ...props,
+    };
+    return (React.createElement(SliderContext.Provider, { value: newProps },
+        React.createElement(Slider, { ref: ref })));
+});
+/**
+ * 滑动型输入器，展示当前值和可选范围。
+ * @en Slide input component, displays the current value and optional range.
+ * @name 滑动输入条
+ * @name_en Slider
+ * @type 数据录入
+ * @type_en Data Entry
+ * @displayName Slider
+ */
+export default componentWrapper(SliderWrapper, 'Slider');

package/esnext/slider/marks.d.ts

@@ -0,0 +1,11 @@
+import { CSSProperties, ReactNode } from 'react';
+declare function Marks({ runTimeConfig, className, style, }: {
+    runTimeConfig: Array<{
+        value: number;
+        activated: boolean;
+        label: ReactNode;
+    }>;
+    className?: string;
+    style?: CSSProperties;
+}): JSX.Element;
+export default Marks;

package/esnext/slider/marks.js

@@ -0,0 +1,17 @@
+import React, { useContext, useCallback } from 'react';
+import { cls } from '@arco-design/mobile-utils';
+import { GlobalContext } from '../context-provider';
+import { SliderContext } from './hooks';
+function Marks({ runTimeConfig, className = '', style = {}, }) {
+    const { prefixCls = '', useRtl } = useContext(GlobalContext);
+    const { type, showMarks, max, min } = useContext(SliderContext);
+    const isHorizontal = /^horizontal/g.test(type);
+    const genMarkStyle = useCallback((value) => {
+        const leftStyle = useRtl ? 'right' : 'left';
+        return {
+            [isHorizontal ? leftStyle : 'bottom']: `${((value - min) / (max - min)) * 100}%`,
+        };
+    }, [isHorizontal, min, max]);
+    return (React.createElement("div", { className: `${prefixCls}-slider-marks` }, runTimeConfig.map(({ value, label, activated }) => (React.createElement("div", { key: value, className: cls(`${prefixCls}-slider-marks-item`, { 'is-activated': activated }, className), style: { ...genMarkStyle(value), ...style } }, showMarks && (React.createElement("div", { className: `${prefixCls}-slider-marks-item-label` }, label)))))));
+}
+export default Marks;

package/esnext/slider/popover.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+export declare function Popover({ visible, content, children, }: {
+    visible: boolean;
+    content: ReactNode;
+    children: ReactNode;
+}): JSX.Element;

package/esnext/slider/popover.js

@@ -0,0 +1,13 @@
+import React, { useContext, useRef } from 'react';
+import Transition from '../transition';
+import { GlobalContext } from '../context-provider';
+export function Popover({ visible, content, children, }) {
+    const { prefixCls = '' } = useContext(GlobalContext);
+    const domRef = useRef(null);
+    return (React.createElement("div", { className: `${prefixCls}-slider-popover-wrapper` },
+        React.createElement(Transition, { in: visible, timeout: 300, type: "fade", mountOnEnter: true, unmountOnExit: true, nodeRef: domRef },
+            React.createElement("div", { className: `${prefixCls}-slider-popover${content ? '' : ' no-content'}`, ref: domRef },
+                React.createElement("div", { className: `${prefixCls}-slider-popover-content` }, content),
+                React.createElement("div", { className: `${prefixCls}-slider-popover-arrow` }))),
+        children));
+}