JGuang

滑块

Slider · Material UI

交互预览
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1

滑块

通过原生刻度与可访问标签选择单值或范围值。

本指南覆盖默认 Emotion 环境的 Material UI Core;扩展包与额外示例按清单单独标注。

使用场景与业务边界

Slider 可能返回 number 或 number[];区分实时变化与提交变化,并明确映射非线性尺度。

原生组成与范围

Slider

保持 Material UI 原生组合与类型,不替换为 JGuang/Base UI/Radix 同名 API。示例条目不是额外组件。

原生安装与初始化

npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1

采用原生 npm 包与 Emotion,不提供虚构的 JGuang UI Registry 地址。将示例放在原生 ThemeProvider 内,按项目选择 CssBaseline 或 ScopedCssBaseline。先检查 React、现有 Provider、锁文件与 SSR 配置;不要覆盖用户文件或忽略 peer 冲突。本批实际验收 React 19.2.8;React 18 及以下须匹配 react-is。完整初始化规则见随附的双语 setup 文档。

关键原生参数

仅解释本指南选出的关键参数,不是平铺的通用 API。原生继承来源、slot 结构、可空值与泛型仍按固定源码保留。

所属组件.属性用途说明声明来源
Slider.value受控原生值,其单值/数组/可空类型取决于所属组件。Slider
Slider.min原生 Slider 最小值。Slider
Slider.maxBadge 显示数量上限或 Slider 最大值,区分所属组件和单位。Slider
Slider.step原生 Slider 步进,null 将选择限制为刻度。Slider
Slider.onChange所属控件的原生回调,保留其准确事件/数值/可空签名。Slider
Slider.onChangeCommittedSlider 交互提交后的回调,与实时变化不同。Slider
Slider.getAriaValueText格式化有意义的 Slider 读屏数值文字,包括单位。Slider

可运行原生示例

下列机器键只选择示例入口,不会作为通用 variant 属性传入每个组件。原生示例 JSX 与数据保持上游原文;JGuang 编写的验收示例明确标注。

  • 连续值滑块 · ContinuousSlider · 上游原生示例
  • 多个尺寸 · SliderSizes · 上游原生示例
  • 离散值滑块 · DiscreteSlider · 上游原生示例
  • 小步进 · DiscreteSliderSteps · 上游原生示例
  • 自定义刻度 · DiscreteSliderMarks · 上游原生示例
  • 限定取值 · DiscreteSliderValues · 上游原生示例
  • 始终显示数值标签 · DiscreteSliderLabel · 上游原生示例
  • 范围滑块 · RangeSlider · 上游原生示例
  • 最小范围间距 · MinimumDistanceSlider · 上游原生示例
  • 带输入框的滑块 · InputSlider · 上游原生示例
  • 颜色 · ColorSlider · 上游原生示例
  • 定制样式 · CustomizedSlider · 上游原生示例
  • 音乐播放器控件演示 · MusicPlayerSlider · 上游原生示例
  • 纵向滑块 · VerticalSlider · 上游原生示例
  • 刻度位置 · CustomMarks · 上游原生示例
  • 去除轨道 · TrackFalseSlider · 上游原生示例
  • 反向轨道 · TrackInvertedSlider · 上游原生示例
  • 非线性尺度 · NonLinearSlider · 上游原生示例

真实使用示例

固定版本的未修改原生示例;复制时同时保留所需的局部辅助文件。

import * as React from 'react';
import Box from '@mui/material/Box';
import Stack from '@mui/material/Stack';
import Slider from '@mui/material/Slider';
import VolumeDown from '@mui/icons-material/VolumeDown';
import VolumeUp from '@mui/icons-material/VolumeUp';

export default function ContinuousSlider() {
  const [value, setValue] = React.useState<number>(30);

  const handleChange = (event: Event, newValue: number) => {
    setValue(newValue);
  };

  return (
    <Box sx={{ width: 200 }}>
      <Stack spacing={2} direction="row" sx={{ alignItems: 'center', mb: 1 }}>
        <VolumeDown />
        <Slider aria-label="Volume" value={value} onChange={handleChange} />
        <VolumeUp />
      </Stack>
      <Slider disabled defaultValue={30} aria-label="Disabled slider" />
    </Box>
  );
}

示例依赖边界

react, @mui/material/Box, @mui/material/Stack, @mui/material/Slider, @mui/icons-material/VolumeDown, @mui/icons-material/VolumeUp, @mui/material/styles, @mui/material/Grid, @mui/material/Typography, @mui/material/Input, @mui/material/Tooltip, @mui/material/IconButton, @mui/icons-material/PauseRounded, @mui/icons-material/PlayArrowRounded, @mui/icons-material/FastForwardRounded, @mui/icons-material/FastRewindRounded, @mui/icons-material/VolumeUpRounded, @mui/icons-material/VolumeDownRounded

直接导入 Icons/System/Utils 的示例需要匹配 9.4.0 包。局部数据与辅助文件属于示例闭包,不是额外组件。远程图片和模拟操作不提供后端。

固定上游 API 元数据参考

以下表格保留上游元数据,不是重新推断的通用类型体系。条件泛型、继承属性与回调细节以以下源码声明为准。主题默认配置可能覆盖元数据默认值。

Slider

import Slider from '@mui/material/Slider';
import { Slider } from '@mui/material';
属性必需上游元数据类型/约束元数据默认值
aria-label否string—
aria-labelledby否string—
aria-valuetext否string—
classes否object—
color否'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string'primary'
defaultValue否Array<number> | number—
disabled否boolfalse
disableSwap否boolfalse
getAriaLabel否func—
getAriaValueText否func—
marks否Array<{ label?: node, value: number }> | boolfalse
max否number100
min否number0
name否string—
onChange否func—
onChangeCommitted否func—
orientation否'horizontal' | 'vertical''horizontal'
scale否funcfunction Identity(x) { return x; }
shiftStep否number10
size否'small' | 'medium' | string'medium'
slotProps否{ input?: func | object, mark?: func | object, markLabel?: func | object, rail?: func | object, root?: func | object, thumb?: func | object, track?: func | object, valueLabel?: func | { children?: element, className?: string, open?: bool, style?: object, value?: node, valueLabelDisplay?: 'auto' | 'off' | 'on' } }{}
slots否{ input?: elementType, mark?: elementType, markLabel?: elementType, rail?: elementType, root?: elementType, thumb?: elementType, track?: elementType, valueLabel?: elementType }{}
step否number1
sx否Array<func | object | bool> | func | object—
tabIndex否number—
track否'inverted' | 'normal' | false'normal'
value否Array<number> | number—
valueLabelDisplay否'auto' | 'off' | 'on''off'
valueLabelFormat否func | stringfunction Identity(x) { return x; }

原生源码声明

声明与 import 从固定源码提取,不平铺联合类型或外部继承。英文注释/类型属于原始源码参考,不代表上游正文已全文翻译。共享类型仍位于原生包中。

vendor/src/Slider/Slider.d.ts

import * as React from 'react';

import { SxProps } from '@mui/system';

import { OverridableStringUnion } from '@mui/types';

import { Mark } from './useSlider.types';

import { CreateSlotsAndSlotProps, SlotComponentProps, SlotProps } from '../utils/types';

import { Theme } from '../styles';

import { OverrideProps, OverridableComponent } from '../OverridableComponent';

import SliderValueLabelComponent from './SliderValueLabel';

import { SliderClasses } from './sliderClasses';

export interface SliderPropsColorOverrides {}

export interface SliderPropsSizeOverrides {}

export interface SliderSlots {
  /**
   * The component that renders the root.
   * @default 'span'
   */
  root: React.ElementType;
  /**
   * The component that renders the track.
   * @default 'span'
   */
  track: React.ElementType;
  /**
   * The component that renders the rail.
   * @default 'span'
   */
  rail: React.ElementType;
  /**
   * The component that renders the thumb.
   * @default 'span'
   */
  thumb: React.ElementType;
  /**
   * The component that renders the mark.
   * @default 'span'
   */
  mark: React.ElementType;
  /**
   * The component that renders the mark label.
   * @default 'span'
   */
  markLabel: React.ElementType;
  /**
   * The component that renders the value label.
   * @default SliderValueLabel
   */
  valueLabel: React.ElementType;
  /**
   * The component that renders the input.
   * @default 'input'
   */
  input: React.ElementType;
}

export interface SliderRootSlotPropsOverrides {}

export interface SliderTrackSlotPropsOverrides {}

export interface SliderRailSlotPropsOverrides {}

export interface SliderThumbSlotPropsOverrides {}

export interface SliderMarkSlotPropsOverrides {}

export interface SliderMarkLabelSlotPropsOverrides {}

export interface SliderValueLabelSlotPropsOverrides {}

export interface SliderInputSlotPropsOverrides {}

export type SliderSlotsAndSlotProps = CreateSlotsAndSlotProps<
  SliderSlots,
  {
    /**
     * Props forwarded to the root slot.
     * By default, the available props are based on the span element.
     */
    root: SlotProps<'span', SliderRootSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the track slot.
     * By default, the available props are based on the span element.
     */
    track: SlotProps<'span', SliderTrackSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the rail slot.
     * By default, the available props are based on the span element.
     */
    rail: SlotProps<'span', SliderRailSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the thumb slot.
     * By default, the available props are based on the span element.
     */
    thumb: SlotProps<'span', SliderThumbSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the mark slot.
     * By default, the available props are based on the span element.
     */
    mark: SlotProps<'span', SliderMarkSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the mark label slot.
     * By default, the available props are based on the span element.
     */
    markLabel: SlotProps<'span', SliderMarkLabelSlotPropsOverrides, SliderOwnerState>;
    /**
     * Props forwarded to the value label slot.
     * By default, the available props are based on the [SliderValueLabel](https://mui.com/material-ui/api/slider/) component.
     */
    valueLabel: SlotComponentProps<
      typeof SliderValueLabelComponent,
      SliderValueLabelSlotPropsOverrides,
      SliderOwnerState
    >;
    /**
     * Props forwarded to the input slot.
     * By default, the available props are based on the input element.
     */
    input: SlotProps<'input', SliderInputSlotPropsOverrides, SliderOwnerState>;
  }
>;

export interface SliderOwnerState extends SliderProps {
  dragging: boolean;
  marked: boolean;
  focusedThumbIndex: number;
}

export interface SliderOwnProps<Value extends number | readonly number[]> {
  /**
   * The label of the slider.
   */
  'aria-label'?: string | undefined;
  /**
   * The id of the element containing a label for the slider.
   */
  'aria-labelledby'?: string | undefined;
  /**
   * A string value that provides a user-friendly name for the current value of the slider.
   */
  'aria-valuetext'?: string | undefined;
  /**
   * The color of the component.
   * It supports both default and custom theme colors, which can be added as shown in the
   * [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
   * @default 'primary'
   */
  color?:
    | OverridableStringUnion<
        'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
        SliderPropsColorOverrides
      >
    | undefined;
  /**
   * Override or extend the styles applied to the component.
   */
  classes?: Partial<SliderClasses> | undefined;
  /**
   * @ignore
   */
  className?: string | undefined;
  /**
   * The default value. Use when the component is not controlled.
   */
  defaultValue?: Value | undefined;
  /**
   * If `true`, the component is disabled.
   * @default false
   */
  disabled?: boolean | undefined;
  /**
   * If `true`, the active thumb doesn't swap when moving pointer over a thumb while dragging another thumb.
   * @default false
   */
  disableSwap?: boolean | undefined;
  /**
   * 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?: ((index: number) => string) | undefined;
  /**
   * 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?: ((value: number, index: number) => string) | undefined;
  /**
   * 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?: boolean | readonly Mark[] | undefined;
  /**
   * The maximum allowed value of the slider.
   * Should not be equal to min.
   * @default 100
   */
  max?: number | undefined;
  /**
   * The minimum allowed value of the slider.
   * Should not be equal to max.
   * @default 0
   */
  min?: number | undefined;
  /**
   * Name attribute of the hidden `input` element.
   */
  name?: string | undefined;
  /**
   * 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 {Value} value The new value.
   * @param {number} activeThumb Index of the currently moved thumb.
   */
  onChange?: ((event: Event, value: Value, activeThumb: number) => void) | undefined;
  /**
   * Callback function that is fired when the pointer or touch interaction ends.
   *
   * @param {React.SyntheticEvent | Event} event The event source of the callback. **Warning**: This is a generic event not a change event.
   * @param {Value} value The new value.
   */
  onChangeCommitted?: ((event: React.SyntheticEvent | Event, value: Value) => void) | undefined;
  /**
   * The component orientation.
   * @default 'horizontal'
   */
  orientation?: 'horizontal' | 'vertical' | undefined;
  /**
   * A transformation function, to change the scale of the slider.
   * @param {any} x
   * @returns {any}
   * @default function Identity(x) {
   *   return x;
   * }
   */
  scale?: ((value: number) => number) | undefined;
  /**
   * The granularity with which the slider can step through values when using Page Up/Page Down or Shift + Arrow Up/Arrow Down.
   * @default 10
   */
  shiftStep?: number | undefined;
  /**
   * The size of the slider.
   * @default 'medium'
   */
  size?: OverridableStringUnion<'small' | 'medium', SliderPropsSizeOverrides> | undefined;
  /**
   * 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?: number | null | undefined;
  /**
   * The system prop that allows defining system overrides as well as additional CSS styles.
   */
  sx?: SxProps<Theme> | undefined;
  /**
   * Tab index attribute of the hidden `input` element.
   */
  tabIndex?: number | undefined;
  /**
   * 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?: 'normal' | false | 'inverted' | undefined;
  /**
   * The value of the slider.
   * For ranged sliders, provide an array with two values.
   */
  value?: Value | undefined;
  /**
   * 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?: 'on' | 'auto' | 'off' | undefined;
  /**
   * 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
   * @param {any} x
   * @returns {any}
   * @default function Identity(x) {
   *   return x;
   * }
   */
  valueLabelFormat?: string | ((value: number, index: number) => React.ReactNode) | undefined;
}

export interface SliderTypeMap<
  RootComponent extends React.ElementType = 'span',
  AdditionalProps = {},
  Value extends number | readonly number[] = number | number[],
> {
  props: AdditionalProps & SliderOwnProps<Value> & SliderSlotsAndSlotProps;
  defaultComponent: RootComponent;
}

export type SliderComponent<Value extends number | readonly number[]> = OverridableComponent<
  SliderTypeMap<'span', {}, Value>
>;

export type SliderType = SliderComponent<number> &
  SliderComponent<number[]> &
  SliderComponent<readonly number[]> &
  SliderComponent<number | number[]>;

export interface SliderValueLabelProps extends React.HTMLAttributes<HTMLSpanElement> {
  children: React.ReactElement<unknown>;
  index: number;
  open: boolean;
  value: React.ReactNode;
}

type SliderRootProps = NonNullable<SliderTypeMap['props']['slotProps']>['root'];

type SliderMarkProps = NonNullable<SliderTypeMap['props']['slotProps']>['mark'];

type SliderMarkLabelProps = NonNullable<SliderTypeMap['props']['slotProps']>['markLabel'];

type SliderRailProps = NonNullable<SliderTypeMap['props']['slotProps']>['rail'];

type SliderTrackProps = NonNullable<SliderTypeMap['props']['slotProps']>['track'];

type SliderThumbProps = NonNullable<SliderTypeMap['props']['slotProps']>['thumb'];

export declare const SliderRoot: React.FC<SliderRootProps>;

export declare const SliderMark: React.FC<SliderMarkProps>;

export declare const SliderMarkLabel: React.FC<SliderMarkLabelProps>;

export declare const SliderRail: React.FC<SliderRailProps>;

export declare const SliderTrack: React.FC<SliderTrackProps>;

export declare const SliderThumb: React.FC<SliderThumbProps>;

export declare const SliderValueLabel: React.FC<SliderValueLabelProps>;

declare const Slider: SliderType;

export type SliderProps<
  RootComponent extends React.ElementType = SliderTypeMap['defaultComponent'],
  AdditionalProps = {},
  Value extends number | readonly number[] = number | number[],
> = OverrideProps<SliderTypeMap<RootComponent, AdditionalProps, Value>, RootComponent> & {
  component?: React.ElementType | undefined;
};

安装后验收

执行严格类型检查、生产构建和实际交互。检查键盘标签/焦点、原生支持的禁用/错误/只读语义、深浅色、窄屏和减少动画。按真实宿主数据检查回调,不把复制提示词当作安装完成。初始化工具还需检查服务端 HTML 与无告警水合。

来源与许可

https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e

MIT · @mui/material@9.4.0. 保留上游原始内容与许可证。上游完整原文保留于 vendor/docs,不标为全文中文化。