docs(agents): add design references

This commit is contained in:
2026-08-10 23:34:28 +08:00
parent a2383fc8a1
commit 72a83f5fcd
86 changed files with 8889 additions and 0 deletions

View File

@@ -0,0 +1,70 @@
---
name: arco-vue-textarea
description: "Arco Design Vue 文本域 Textarea 组件参考。用于 Vue 3、`@arco-design/web-vue``<a-textarea>`、属性、事件、插槽、示例和实现细节。"
user-invocable: false
---
# 文本域 Textarea
## 简介
可以用于多行输入。
## 基本用法
```vue
<template>
<a-textarea placeholder="Please enter something" allow-clear/>
</template>
```
## API
### `<textarea>` 属性
|参数名|描述|类型|默认值|版本|
|---|---|---|:---:|:---|
|model-value **(v-model)**|绑定值|`string`|`-`||
|default-value|默认值(非受控状态)|`string`|`''`||
|placeholder|提示文字|`string`|`-`||
|disabled|是否禁用|`boolean`|`false`||
|error|是否为错误状态|`boolean`|`false`||
|max-length|输入值的最大长度errorOnly 属性在 2.12.0 版本添加|`number \| { length: number; errorOnly?: boolean }`|`0`||
|show-word-limit|是否显示字数统计|`boolean`|`false`||
|allow-clear|是否允许清空文本域|`boolean`|`false`||
|auto-size|是否让文本框自适应内容高度|`boolean \| { minRows?: number; maxRows?: number }`|`false`||
|word-length|字符长度的计算方法|`(value: string) => number`|`-`||
|word-slice|字符截取方法,同 wordLength 一起使用|`(value: string, maxLength: number) => string`|`-`|2.12.0|
|textarea-attrs|透传给 textarea 的属性|`Record<string, any>`|`-`||
### `<textarea>` 事件
|事件名|描述|参数|
|---|---|---|
|input|用户输入时触发|value: `string`<br>ev: `Event`|
|change|仅在文本框失焦时触发|value: `string`<br>ev: `Event`|
|clear|点击清除按钮时触发|ev: `MouseEvent`|
|focus|文本框获取焦点时触发|ev: `FocusEvent`|
|blur|文本框失去焦点时触发|ev: `FocusEvent`|
### `<textarea>` 方法
|方法名|描述|参数|返回值|版本|
|---|---|---|---|:---|
|focus|使输入框获取焦点|-|-|2.24.0|
|blur|使输入框失去焦点|-|-|2.24.0|
## 常用模式
- **基本使用**:可以用于多行输入。
- **文本域状态**:文本域可以设置禁用和错误状态。
- **字数统计**:设置 `max-length` 可以限制最大字数,配合 `show-word-limit` 可以显示字数统计。
- **自适应高度**:通过设置 `auto-size`,可以让文本框自适应输入内容。
## 最佳实践
- 新代码优先使用 Vue 3、Composition API 和 `<script setup lang="ts">`
- 模板属性使用 kebab-case事件使用 `@event-name`,插槽使用 `#slot-name`
- 不要套用 React 专属 API例如 JSX children、`Component.Sub``Form.useForm`
- 需要进入表单校验或提交流程的控件,优先放在 `a-form-item` 中并绑定明确的 `field`
- 输入值优先使用 `v-model`;范围、弹窗类状态使用组件文档中的命名 `v-model:*`