From e74537946f3944299b48f997a10396959b2caca8 Mon Sep 17 00:00:00 2001 From: MrXiangXvFan <74048960+MrXiangXvFan@users.noreply.github.com> Date: Wed, 9 Oct 2024 09:34:28 +0800 Subject: [PATCH] docs: rate upate --- packages/vantui/src/rate/index.tsx | 4 ++-- packages/vantui/types/rate.d.ts | 25 +++++++++++++++++++++++-- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/packages/vantui/src/rate/index.tsx b/packages/vantui/src/rate/index.tsx index e63f0a494..dfa487717 100644 --- a/packages/vantui/src/rate/index.tsx +++ b/packages/vantui/src/rate/index.tsx @@ -11,13 +11,13 @@ export function Rate(props: RateProps) { gutter, icon = 'star', voidIcon = 'star-o', - disabled, + disabled = false, size, disabledColor, color, voidColor, allowHalf, - readonly, + readonly = false, touchable = true, value, onChange, diff --git a/packages/vantui/types/rate.d.ts b/packages/vantui/types/rate.d.ts index d1557d964..811f32237 100644 --- a/packages/vantui/types/rate.d.ts +++ b/packages/vantui/types/rate.d.ts @@ -2,34 +2,46 @@ import { FunctionComponent } from 'react' import { ViewProps, ITouchEvent } from '@tarojs/components' export interface RateProps extends ViewProps { + /** + * @description 当前分值 + */ value?: number /** - * @description 默认值 + * @description 默认分值 */ defaultValue?: number /** * @description 是否只可读 + * @default false */ readonly?: boolean /** * @description 是否禁用 + * @default false */ disabled?: boolean /** - * @description 是否允许选择一般 + * @description 是否允许半选 + * @default false */ allowHalf?: boolean + /** + * @description 图标大小,默认单位为px + */ size?: string | number /** * @description 自定义图标的classPrefix + * @default van-icon */ iconClassPrefix?: string /** * @description 选中图标 + * @default star */ icon?: string /** * @description 未选中图标 + * @default star-o */ voidIcon?: string /** @@ -42,17 +54,26 @@ export interface RateProps extends ViewProps { voidColor?: string /** * @description 禁用颜色 + * @default #c8c9cc */ disabledColor?: string /** * @description 总体数量 + * @default 5 */ count?: number /** * @description 图标间距,默认单位为 px */ gutter?: string | number + /** + * @description 是否可以通过滑动手势选择评分 + * @default true + */ touchable?: boolean + /** + * @description 当前分值变化时触发的事件 + */ onChange?: (e: ITouchEvent) => any }