shineout/css/Rate/Props.ts

Shein 前端组件库

import { ReactElement, ReactNode } from 'react'
import { StandardProps } from '../@types/common'
import { GetInputableProps } from '../Form/Props'

/**
 * @title RateFunction
 * @subTitle (background, front): ReactClass
 */
export type ArgProps = {
  /**
   * @en Unselected element background
   * @cn 未选中元素背景
   * @override ReactElement | string | Array<string | ReactElement>
   */
  background: ReactElement | string | Array<string | ReactElement>

  /**
   * @en selected element background
   * @cn 选中元素背景
   * @override ReactElement | string | Array<string | ReactElement>
   * @default background
   */
  front?: ReactElement | string | Array<string | ReactElement>
}

export declare interface OriginRateProps extends ArgProps, StandardProps {
  /**
   * @en Form field, used with Form
   * @cn 表单字段, 配合 Form 使用
   */
  name?: string
  /**
   * @en Whether to allow semi selection
   * @cn 是否允许半选
   * @default false
   */
  allowHalf?: boolean

  /**
   * @en whether to allow clear when click again
   * @cn 是否允许再次点击后清除
   * @default false
   */
  clearable?: boolean

  /**
   * @en read-only
   * @cn 是否只读
   * @default false
   */
  disabled?: boolean

  /**
   * @en The maximum value of the option, integer
   * @cn 选项最大值，整数
   * @default 5
   */
  max?: number

  /**
   * @en When repeat is true, display item is a copy of the item corresponding to the current value
   * @cn 为 true 时，显示的选项为当前分值对应选项的复制
   * @default true
   */
  repeat?: boolean

  /**
   * @en the size of the icon
   * @cn 图标大小
   * @default 20
   */
  size?: number | string

  /**
   * @en Text
   * @cn 附加文字
   */
  text?: Array<ReactNode>

  /**
   * @en Selected key (controlled)
   * @cn 选中的 key （受控)
   * @default 0
   */
  value: number

  /**
   * @en value change callback
   * @cn 值改变回调
   */
  onChange: (value: number) => void
}

export type RatePropsWithInput = GetInputableProps<Omit<OriginRateProps, keyof ArgProps>, string>

/**
 * @title Rate
 */
export type RateProps = Omit<RatePropsWithInput, 'filterSameChange'>