# NumberBox 步进器

该组件一般用于商城购物选择物品数量的场景

注意:该输入框只能输入大于或等于0的整数

# 平台差异说明

App(vue) App(nvue) H5 小程序

# 基本使用

通过v-model绑定modelValue初始值,此值是双向绑定的,无需在回调中将返回的数值重新赋值给modelValue

<template>
	<up-number-box v-model="value" @change="valChange"></up-number-box>
</template>
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const value = ref(0);  
  
// 定义方法  
function valChange(e) {  
  console.log('当前值为: ' + e.target.value);  
}  
</script>
<script>
	export default {
		data() {
			return {
				value: 0
			}
		},
		methods: {
			valChange(e) {
				console.log('当前值为: ' + e.value)
			}
		}
	}
</script>

# 步长设置

  • 通过step属性设置每次点击增加或减少按钮时变化的值,默认为1,下面示例每次都会加2或者减2
<up-number-box :step="2"></up-number-box>

# 限制输入范围

通过minmax参数限制输的入值最小值和最大值

<up-number-box :min="1" :max="100"></up-number-box>

# 限制只能输入整数

通过integer限制输入类型

<up-number-box integer></up-number-box>

# 禁用

<!-- 通过设置`disabled`参数来禁用输入框,禁用状态下无法点击加减按钮或修改输入框的值 -->
<up-number-box :disabled="true"></up-number-box>

<!-- 禁用输入框 -->
<up-number-box :disabledInput="true"></up-number-box>

<!-- 禁用增加按钮 -->
<up-number-box :disablePlus="true"></up-number-box>

<!-- 禁用减少按钮 -->
<up-number-box :disableMinus="true"></up-number-box>

<!-- 禁用长按 -->
<up-number-box :longPress="false"></up-number-box>

# 固定小数位数

通过step设置步进长度,decimal-length设置显示小数位数

<up-number-box step="0.25" decimal-length="1" ></up-number-box>

# 异步变更

通过asyncChange设置异步变更,开启后需要手动控制输入值 (默认 false )

<template>
    <up-number-box v-model="value" :asyncChange="true" @change="onChange"></up-number-box>
</template>
<script setup>  
import { ref, onMounted } from 'vue';  
  
// 创建响应式数据  
const value = ref(1);  
  
// 定义方法  
function onChange(e) {  
  setTimeout(() => {  
    value.value += 1; // 使用 value.value 来访问和修改响应式数据  
  }, 3000);  
}
</script>
<script>
export default {
    data(){
        return {
            value:1
        }
    },
    methods:{
        onChange(e){
            setTimeout(() => {
                this.value = this.value + 1;
            }, 3000)
        }
    }
}
</script>

# 自定义颜色和大小

  • 通过button-size参数设置按钮大小
  • 通过icon-style参数设置加减按钮图标的样式
<up-number-box 
    button-size="36"
    color="#ffffff"
    bgColor="#2979ff"
    iconStyle="color: #fff"
></up-number-box>

# 自定义 slot

<template>
    <up-number-box v-model="value">
        <template #minus>
            <view
                class="minus"
            >
                <up-icon
                    name="minus"
                    size="12"
                ></up-icon>
            </view>
        </template>
        <template #input>
            <text
                style="width: 50px;text-align: center;"
                class="input"
            >{{value}}</text>
        </template>
        <template #plus>
            <view
                class="plus"
            >
                <up-icon
                    name="plus"
                    color="#FFFFFF"
                    size="12"
                ></up-icon>
            </view>
        </template>
    </up-number-box>
</template>
<script setup>  
import { ref } from 'vue';  
  
// 创建响应式数据  
const value = ref(1);  
</script>
<script>
export default {
    data(){
        return {
            value:1
        }
    }
}
</script>
<style lang="scss">
	.minus {
		width: 22px;
		height: 22px;
		border-width: 1px;
		border-color: #E6E6E6;
		border-top-left-radius: 100px;
		border-top-right-radius: 100px;
		border-bottom-left-radius: 100px;
		border-bottom-right-radius: 100px;
		@include flex;
		justify-content: center;
		align-items: center;
	}

	.input {
		padding: 0 10px;
	}

	.plus {
		width: 22px;
		height: 22px;
		background-color: #FF0000;
		border-radius: 50%;
		/* #ifndef APP-NVUE */
		display: flex;
		/* #endif */
		justify-content: center;
		align-items: center;
	}
</style>

# 右侧演示页面源代码地址

点击以下链接以查看右侧演示页面的源码


 github  gitee

# API

# Props

参数 说明 类型 默认值 可选值
name 步进器标识符,在change回调返回 String | Number - -
modelValue 用于双向绑定的值,初始化时设置设为默认min值(最小值) String | Number 1 -
min 用户可输入的最小值 String | Number 1 -
max 用户可输入的最大值 String | Number Number.MAX_SAFE_INTEGER -
step 步长,每次加或减的值, 支持小数值,如需小数 String | Number 1 -
integer 是否只能输入正整数 Boolean false true
disabled 是否禁用操作,包括输入框,加减按钮 Boolean false true
disabledInput 是否禁止输入框 Boolean false true
asyncChange 是否开启异步变更,开启后需要手动控制输入值 Boolean false true
inputWidth 输入框宽度,单位px String | Number 35 -
showMinus 是否显示减少按钮 Boolean true false
showPlus 是否显示增加按钮 Boolean true false
decimalLength 显示的小数位数 String | Number - -
longPress 是否允许长按进行加减 Boolean true false
color 输入框文字和加减按钮图标的颜色 String #323233 -
buttonSize 按钮大小,宽高等于此值,单位px,输入框高度和此值保持一致 String | Number 30 -
bgColor 输入框和按钮的背景颜色 String #EBECEE -
cursorSpacing 指定光标于键盘的距离,避免键盘遮挡输入框,单位px String | Number 100 -
disablePlus 是否禁用增加按钮 Boolean false true
disableMinus 是否禁用减少按钮 Boolean false true
iconStyle 加减按钮图标的样式 String - -

# Events

事件名 说明 回调参数
focus 输入框得到焦点触发(按钮可点击情况下),对象形式 value:输入框当前值,name:步进器标识符
blur 输入框失去焦点时触发,对象形式 value:输入框当前值,name:步进器标识符
change 输入框内容发生变化时触发,对象形式 value:输入框当前值,name:步进器标识符
overlimit 超过范围阈值时触发 type:(minus已达最小值,plus已达最大值)

# Slots

名称 说明
minus 减少按钮
input 输入框
plus 增加按钮