readme.md 3.2 KB
Newer Older
雪洛's avatar
雪洛 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107


## Rate 评分
> **组件名:uni-rate**
> 代码块: `uRate`
> 关联组件:`uni-icons`


评分组件,多用于购买商品后,对商品进行评价等场景

> **注意事项**
> 为了避免错误使用,给大家带来不好的开发体验,请在使用组件前仔细阅读下面的使用说明,可以帮你避免一些错误。
> - 暂时不支持零星选择
> - 当前版本暂不支持修改图标,后续版本会继续优化
> - 绑定值推荐使用 `v-model` 的方式
> - 如需设置一个星星表示多分,如:显示5个星星,最高分10分。这种情况请在 change 事件监听中自行处理,获取到的值乘以你的基数就可以,默认组件是一星一分


### 安装方式

本组件符合[easycom](https://uniapp.dcloud.io/collocation/pages?id=easycom)规范,`HBuilderX 2.5.5`起,只需将本组件导入项目,在页面`template`中即可直接使用,无需在页面中`import`和注册`components`

如需通过`npm`方式使用`uni-ui`组件,另见文档:[https://ext.dcloud.net.cn/plugin?id=55](https://ext.dcloud.net.cn/plugin?id=55)


## 基本用法 

```html
<!-- 基本用法 -->
<!-- 需要在 script 中绑定 value 变量 -->
<uni-rate v-model="value" @change="onChange"/>

<!-- 不支持滑动手势选择评分 -->
<uni-rate :touchable="false" :value="5"/>
<!-- 设置尺寸大小 -->
<uni-rate :size="18" :value="5"/>

<!-- 设置评分数 -->
<uni-rate :max="10" :value="5" />
	
<!-- 设置星星间隔 -->
<uni-rate :value="4" :margin="20" />	

<!-- 设置颜色 -->
<uni-rate :value="3" color="#bbb" active-color="red" />

<!-- 选择半星 -->
<uni-rate allow-half :value="3.5" />

<!-- 只读状态 -->
<uni-rate :readonly="true" :value="2" />

<!-- 禁用状态 -->
<uni-rate :disabled="true" disabledColor="#ccc" :value="3" />

<!-- 未选中的星星为镂空状态 -->
<uni-rate :value="3" :is-fill="false" />

			 
```

```javascript

export default {
	components: {},
	data() {
		return {
			value: 2
		}
	},
	methods: {
		onChange(e) {
			console.log('rate发生改变:' + JSON.stringify(e))
		}
	}
}

```

## API
### Rate Props

属性名			|	类型			|	默认值	|	说明																									
:-:				|	:-:		|	:-:		|	:-:	
value/v-model	|	Number 	 	| 1			|	当前评分
color 			|	String 	 	| #ececec	|	未选中状态的星星颜色
activeColor 	|	String 	 	| #ffca3e	|	选中状态的星星颜色
disabledColor 	|	String 	 	| #c0c0c0	|	禁用状态的星星颜色
size 			|	Number 	 	| 24		|	星星的大小
max 			|	Number 	 	| 5			|	最大评分评分数量,目前一分一颗星
margin 			|	Number 	 	| 0			|	星星的间距,单位 px
isFill 			| 	Boolean 	| true		|	星星的类型,是否为实心类型
disabled 		|	Boolean 	| false		|	是否为禁用状态 (之前版本为已读状态,现更正为禁用状态)
readonly 		|	Boolean 	| false		| 	是否为只读状态
allowHalf		| 	Boolean 	| false		|	是否展示半星
touchable		|	Boolean 	| true		|	是否支持滑动手势

### Rate Events

事件称名			|	说明						|	返回参数			
:-:				|	:-:						|	:-:	
@change			|	改变 value 的值返回		|	e = { value:number }		


## 组件示例

点击查看:[https://hellouniapp.dcloud.net.cn/pages/extUI/rate/rate](https://hellouniapp.dcloud.net.cn/pages/extUI/rate/rate)