JGuang

评分

Rate · Ant Design

交互预览
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

评分

用于对事物进行评分操作。

何时使用

  • 对评价进行展示。
  • 对事物进行快速的评级操作。

代码演示

  • 基本 · basic
  • 尺寸 · size
  • 半星 · half
  • 文案展现 · text
  • 只读 · disabled
  • 清除 · clear
  • 其他字符 · character
  • 自定义字符 · character-function

API

通用属性参考:通用属性

属性说明类型默认值版本全局配置
allowClear是否允许再次点击后清除booleantrue×
allowHalf是否允许半选booleanfalse×
character自定义字符ReactNode | (RateProps) => ReactNode<StarFilled />function(): 4.4.0×
countstar 总数number5×
defaultValue默认值number0×
disabled只读,无法进行交互booleanfalse×
keyboard支持使用键盘操作booleantrue5.18.0×
size星星尺寸'small' | 'medium' | 'large''medium'×
tooltips自定义每项的提示信息TooltipProps[] | string[]-×
value当前数,受控值number-×
onBlur失去焦点时的回调function()-×
onChange选择时的回调function(value: number)-×
onFocus获取焦点时的回调function()-×
onHoverChange鼠标经过时数值变化的回调function(value: number)-×
onKeyDown按键回调function(event)-×

方法

名称描述
blur()移除焦点
focus()获取焦点

主题变量(Design Token)

类型、继承关系和原生令牌声明保持固定源码原文;默认值由原生主题计算,并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。

令牌类型原生说明
starColorstring星星颜色
starSizenumber星星尺寸
starSizeSMnumber小星星尺寸
starSizeLGnumber大星星尺寸
starHoverScaleCSSObject['transform']星星悬浮时的缩放
starBgstring星星背景色

声明来源: vendor/components/rate/style/index.ts

import type { CSSObject } from '@ant-design/cssinjs';

import { unit } from '@ant-design/cssinjs';

import { resetComponent } from '../../style';

import type { FullToken, GenerateStyle, GetDefaultToken } from '../../theme/internal';

import { genStyleHooks, mergeToken } from '../../theme/internal';

export interface ComponentToken {
  /**
   * @desc 星星颜色
   * @descEN Star color
   */
  starColor: string;
  /**
   * @desc 星星尺寸
   * @descEN Star size
   */
  starSize: number;
  /**
   * @desc 小星星尺寸
   * @descEN Small star size
   */
  starSizeSM: number;
  /**
   * @desc 大星星尺寸
   * @descEN Large star size
   */
  starSizeLG: number;
  /**
   * @desc 星星悬浮时的缩放
   * @descEN Scale of star when hover
   */
  starHoverScale: CSSObject['transform'];
  /**
   * @desc 星星背景色
   * @descEN Star background color
   */
  starBg: string;
}

interface RateToken extends FullToken<'Rate'> {}

原生通用属性

Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。

参数说明类型默认值
style自定义样式CSSProperties-
className自定义类名string-
rootClassName添加在组件最外层的 classNamestring-
autoFocus自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效booleanfalse

安装并复现示例

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

原生类型参考

源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

  • vendor/components/rate/index.tsx
  • vendor/components/rate/style/index.ts

来源与许可

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。