Skip to content

📝 Add docstrings to fix/slider-typo #1459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

📝 Add docstrings to fix/slider-typo #1459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions components/slider/slider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ function nearest(arr: number[], target: number) {
})
}

/**
* 渲染一个可配置的滑块组件，支持单值或区间、刻度、标记、手势交互、可选弹出提示与触觉反馈。
*
* @param props - Slider 的属性集合（包括最小/最大值、步进、range、marks、ticks、样式、事件回调等），详见 `SliderProps` / `BaseSliderProps` 类型。
* @param ref - 转发的引用，用于调用组件暴露的动作（例如可调用的 `onSlide`）。
* @returns 渲染用于界面的滑块 React 元素，包含轨道、填充、刻度/标记（可选）以及一个或两个滑块拇指用于交互。
*/
function InternalSlider<SliderValue extends SliderValueType>(
props: SliderProps,
ref: ForwardedRef<SliderRef>,
Expand Down Expand Up @@ -382,7 +389,7 @@ function InternalSlider<SliderValue extends SliderValueType>(
return (
<GestureDetector gesture={gesture}>
<View style={[ss.slider, disabled && ss.disabled, style]}>
<View style={ss.trackContianer} onLayout={onTrackLayout}>
<View style={ss.trackContainer} onLayout={onTrackLayout}>
<View style={ss.track} />
<Animated.View style={[ss.fill, fillStyle]} />
{/* 刻度 */}
Expand Down Expand Up @@ -412,4 +419,4 @@ const Slider = React.forwardRef<SliderRef, SliderProps>(InternalSlider) as ((

Slider.displayName = 'Slider'

export default React.memo(Slider)
export default React.memo(Slider)