amis/docs/zh-CN/components/form/input-rating.md
2023-05-28 22:26:48 +08:00

7.4 KiB
Executable File
Raw Permalink Blame History

title description type group menuName icon order
InputRating 评分 0 null InputRating 评分 37

基本用法

默认颜色

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3
        }
    ]
}

自定义颜色。支持各种颜色形式,如 CSS 预定义颜色十六进制颜色RGB 颜色HSL 颜色。

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3,
            "colors": {
                "1": "gray",
                "2": "#678f8d",
                "3": "rgb(119, 168, 141)",
                "4": "hsl(147, 22%, 56%)",
                "5": "#ff6670"
            }
        }
    ]
}

半星

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3.5,
            "half": true
        }
    ]
}

带有文字

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3,
            "texts": {
                "1": "很差",
                "2": "较差",
                "3": "一般",
                "4": "较好",
                "5": "很好"
            },
            "textClassName": "okde"
        }
    ]
}

自定义字符

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3,
            "char": "好"
        }
    ]
}

只读

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "type": "input-rating",
            "name": "rating",
            "label": "评分",
            "count": 5,
            "value": 3.6,
            "half": true,
            "readOnly": true,
            "texts": {
                "5": "3.6"
            }
        }
    ]
}

属性表

当做选择器表单项使用时,除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明
value number - 当前值
half boolean false 是否使用半星选择
count number 5 总星数
readOnly boolean false 只读
allowClear boolean true 是否允许再次点击后清除
colors string / object {'2': '#abadb1', '3': '#787b81', '5': '#ffa900' } 星星被选中的颜色。 若传入字符串,则只有一种颜色。若传入对象,可自定义分段,键名为分段的界限值,键值为对应的类名
inactiveColor string #e7e7e8 未被选中的星星的颜色
texts object - 星星被选中时的提示文字。可自定义分段,键名为分段的界限值,键值为对应的类名
textPosition right / left right 文字的位置
char string 自定义字符
className string - 自定义样式类名
charClassName string - 自定义字符类名
textClassName string - 自定义文字类名

事件表

当前组件会对外派发以下事件,可以通过onEvent来监听这些事件,并通过actions来配置执行的动作,在actions中可以通过${事件参数名}${event.data.[事件参数名]}来获取事件产生的数据,详细请查看事件动作

[name]表示当前组件绑定的名称,即name属性,如果没有配置name属性,则通过value取值。

事件名称 事件参数 说明
change [name]: number 组件的值 分值变化时触发

动作表

当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称componentId: 该组件id来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}来配置具体的参数,详细请查看事件动作

动作名称 动作配置 说明
clear - 清空
reset - 将值重置为resetValue,若没有配置resetValue,则清空
setValue value: number 更新的值 更新数据