ant-design/index.en-US.md at 7385fefeb7df696a695d22d51ea986a2a2e8ac52

mirror of https://github.com/ant-design/ant-design.git synced 2024-11-30 06:09:34 +08:00

* docs: Update components cover

#24629

* docs: Update components cover

2020-06-05 13:50:09 +08:00

category	type	title	cover
Components	Data Entry	Rate	https://gw.alipayobjects.com/zos/alicdn/R5uiIWmxe/Rate.svg

Rate component.

When To Use

Property	Description	type	Default
allowClear	whether to allow clear when click again	boolean	true
allowHalf	whether to allow semi selection	boolean	false
autoFocus	get focus when component mounted	boolean	false
character	custom character of rate	ReactNode	`<StarFilled />`
className	custom class name of rate	string
count	star count	number	5
defaultValue	default value	number	0
disabled	read only, unable to interact	boolean	false
style	custom style object of rate	CSSProperties
tooltips	Customize tooltip by each character	string[]
value	current value	number
onBlur	callback when component lose focus	Function()
onChange	callback when select value	Function(value: number)
onFocus	callback when component get focus	Function()
onHoverChange	callback when hover item	Function(value: number)
onKeyDown	callback when keydown on component	Function(event)

Name	Description
blur()	remove focus
focus()	get focus