Skip to content

Textarea 富文本输入框

用于获取用户输入的长文本。

基础用法

通过标签 <NueTextarea> 声明一个富文本输入框组件。

值与占位字符

通过 v-model 绑定一个响应式数据,随输入内容变化;通过属性 placeholder 设置空值时的占位字符。 类型。

<template>
    <nue-textarea v-model="textareaVModel" placeholder="请输入内容 ..." />
</template>

<script lang="ts" setup>
import { ref } from 'vue';

const textareaVModel = ref('');
</script>

禁用状态

通过属性 disabled 设置禁用状态。

<template>
    <nue-textarea v-model="textareaVModel" disabled placeholder="禁用状态" />
</template>

<script setup>
import { ref } from 'vue';

const textareaVModel = ref('');
</script>

大小

通过属性 size 设置,属性可选值为 smalllarge

<template>
    <nue-div vertical align="stretch">
        <nue-textarea v-model="textareaVModel" placeholder="Please input something" size="large" />
        <nue-textarea v-model="textareaVModel" placeholder="Please input something" size="small" />
    </nue-div>
</template>

<script setup>
import { ref } from 'vue';

const textareaVModel = ref('');
</script>

设置最大行数

通过属性 rows 设置图标。属性值接受数字类型,默认值为 3。当内容行数超过指定值则会显示滚动条。

<template>
    <nue-textarea v-model="textareaVModel" placeholder="请输入内容 ..." :rows="2" />
</template>

<script setup>
import { ref } from 'vue';

const textareaVModel = ref('');
</script>

字数限制与计数

通过属性 maxlength 设置最大字符限制。属性值类型同 HTMLElement.maxlength 属性类型,属于属性映射。

通过属性 counter 设置是否显示字数统计。属性可选值为 off*word-limitword-left 以及 both,其中:

  • off 表示不显示字数统计。
  • word-limit 表示只显示最大字数限制。
  • word-left 表示只显示剩余字数。
  • both 表示同时显示最大字数限制和剩余字数。

TIP

counter 属性需要与 maxlength 属性配合使用才能产生效果。

<template>
    <nue-div vertical align="stretch">
        <nue-textarea
            v-model="textareaVModel"
            placeholder="显示字符限制(正向计数)"
            :maxlength="256"
            counter="word-limit"
        />
        <nue-textarea
            v-model="textareaVModel"
            placeholder="显示剩余字数(逆向计数)"
            :maxlength="256"
            counter="word-left"
        />
        <nue-textarea
            v-model="textareaVModel"
            placeholder="同时显示字符限制和剩余字数"
            :maxlength="256"
            counter="both"
        />
    </nue-div>
</template>

<script setup>
import { ref } from 'vue';

const textareaVModel = ref('');
</script>

防抖

组件内部在输入时会对输入内容进行防抖处理,防止短时间内大量输入导致可能出现的性能问题。

通过 debounceTime 属性设置防抖时间,单位为 ms,接收 number 类型,默认值为 0

<template>
    <nue-div vertical align="stretch">
        <nue-textarea v-model="inputVModel" placeholder="请输入 ..." :debounceTime="500" />
        <nue-text align="center" v-if="inputVModel">{{ inputVModel }}</nue-text>
    </nue-div>
</template>

<script setup>
import { ref } from 'vue';

const inputVModel = ref('');
</script>

自动高度

通过属性 autosize 设置是否启用自适应内容高度,开启后文本框的高度会随着内容的增加而变高,即文本框会完全显示所输入的内容而非使用滚动条。

<template>
    <nue-textarea v-model="textareaVModel" placeholder="请输入内容" autosize />
</template>

<script setup>
    import { ref } from 'vue';

    const textareaVModel = ref('');
</script>

限制高度

属性 autosize 可以实现文本框高度自适应内容,但有时候并不是无限增高,会希望输入框在一定高度内保持自适应,可以搭配属性 rows 设置最大高度限制,当内容高度超过 rows 指定的行数时,则不会继续增加文本框高度,转而显示滚动条。

<template>
    <nue-textarea
        v-model="textareaVModel1"
        placeholder="请输入内容(3行最大高度)"
        autosize
        :rows="3"
    />
</template>

<script setup>
import { ref } from 'vue';

const textareaVModel1 = ref('');
</script>

手动调整输入框宽高

通过属性 resize 设置输入框宽高手动调整。属性为 HTMLElement.resize 的映射。

<template>
    <nue-div align="center">
        <nue-textarea v-model="textareaValue" :rows="4" resize />
    </nue-div>
</template>

<script setup lang="ts">
import { ref } from 'vue';

const textareaValue = ref('');
</script>

Released under the MIT License.