# textarea

基础库 1.0.0 开始支持，低版本需做兼容处理。

微信 Windows 版：支持

微信 Mac 版：支持

渲染框架支持情况：Skyline （使用最新 Nighly 工具调试）、WebView

# 功能描述

多行输入框。该组件是原生组件，使用时请注意相关限制。

# 通用属性

属性类型默认值必填说明最低版本

value string 否输入框的内容 1.0.0

placeholder string 否输入框为空时占位符 1.0.0

placeholder-style string 否指定 placeholder 的样式，目前仅支持color,font-size和font-weight 1.0.0

disabled boolean false 否是否禁用 1.0.0

maxlength number 140 否最大输入长度，设置为 -1 的时候不限制最大长度 1.0.0

auto-focus boolean false 否自动聚焦，拉起键盘。 1.0.0

focus boolean false 否获取焦点 1.0.0

auto-height boolean false 否是否自动增高，设置auto-height时，style.height不生效 1.0.0

cursor-spacing number 0 否指定光标与键盘的距离。取textarea距离底部的距离和cursor-spacing指定的距离的最小值作为光标与键盘的距离 1.0.0

cursor number -1 否指定focus时的光标位置 1.5.0

selection-start number -1 否光标起始位置，自动聚集时有效，需与selection-end搭配使用 1.9.0

selection-end number -1 否光标结束位置，自动聚集时有效，需与selection-start搭配使用 1.9.0

adjust-position boolean true 否键盘弹起时，是否自动上推页面 1.9.90

hold-keyboard boolean false 否 focus时，点击页面的时候不收起键盘 2.8.2

disable-default-padding boolean false 否是否去掉 iOS 下的默认内边距 2.10.0

confirm-type string return 否设置键盘右下角按钮的文字 2.13.0

合法值	说明
send	右下角按钮为“发送”
search	右下角按钮为“搜索”
next	右下角按钮为“下一个”
go	右下角按钮为“前往”
done	右下角按钮为“完成”
return	右下角按钮为“换行”

confirm-hold boolean false 否点击键盘右下角按钮时是否保持键盘不收起 2.16.0

adjust-keyboard-to boolean cursor 否键盘对齐位置。鸿蒙 OS 暂不支持 2.16.1

合法值	说明
cursor	对齐光标位置
bottom	对齐输入框底部

bindfocus eventhandle 否输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 1.0.0

bindblur eventhandle 否输入框失去焦点时触发，event.detail = {value, cursor} 1.0.0

bindlinechange eventhandle 否输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0} 1.0.0

bindinput eventhandle 否当键盘输入时，触发 input 事件，event.detail = {value, cursor, keyCode}，keyCode 为键值，目前工具还不支持返回keyCode参数。**bindinput 处理函数的返回值并不会反映到 textarea 上** 1.0.0

bindconfirm eventhandle 否点击完成时，触发 confirm 事件，event.detail = {value: value} 1.0.0

bindkeyboardheightchange eventhandle 否键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} 2.7.0

# Skyline 特有属性

属性	类型	必填	说明	最低版本
placeholder-style	string	否	需传入对象，格式为 `{ fontSize: number, fontWeight: string, color: string }`
bind:selectionchange	eventhandle	否	选区改变事件, {selectionStart, selectionEnd}	3.2.0
bind:keyboardcompositionstart	eventhandle	否	输入法开始新的输入时触发（仅当输入法支持时触发）	3.2.0
bind:keyboardcompositionupdate	eventhandle	否	输入法输入字符时触发（仅当输入法支持时触发）	3.2.0
bind:keyboardcompositionend	eventhandle	否	输入法输入结束时触发（仅当输入法支持时触发）	3.2.0

# WebView 特有属性

属性	类型	默认值	必填	说明	最低版本
placeholder-class	string	textarea-placeholder	否	指定 placeholder 的样式类，目前仅支持color,font-size和font-weight	1.0.0
fixed	boolean	false	否	如果 textarea 是在一个 `position:fixed` 的区域，需要显示指定属性 fixed 为 true	1.0.0
show-confirm-bar	boolean	true	否	是否显示键盘上方带有”完成“按钮那一栏	1.6.0

# Bug & Tip

tip: textarea 的 blur 事件会晚于页面上的 tap 事件，如果需要在 button 的点击事件获取 textarea，可以使用 form 的 bindsubmit。
tip: 不建议在多行文本上对用户的输入进行修改，所以 textarea 的 bindinput 处理函数并不会将返回值反映到 textarea 上。
tip : 键盘高度发生变化，keyboardheightchange事件可能会多次触发，开发者对于相同的height值应该忽略掉
bug: 微信版本 6.3.30，textarea 在列表渲染时，新增加的 textarea 在自动聚焦时的位置计算错误。

# 示例代码

在开发者工具中预览效果

<view class="section">
  <textarea bindblur="bindTextAreaBlur" auto-height placeholder="自动变高" />
</view>
<view class="section">
  <textarea placeholder="placeholder颜色是红色的" placeholder-style="color:red;"  />
</view>
<view class="section">
  <textarea placeholder="这是一个可以自动聚焦的textarea" auto-focus />
</view>
<view class="section">
  <textarea placeholder="这个只有在按钮点击的时候才聚焦" focus="{{focus}}" />
  <view class="btn-area">
    <button bindtap="bindButtonTap">使得输入框获取焦点</button>
  </view>
</view>
<view class="section">
  <form bindsubmit="bindFormSubmit">
    <textarea placeholder="form 中的 textarea" name="textarea"/>
    <button form-type="submit"> 提交 </button>
  </form>
</view>

//textarea.js
Page({
  data: {
    height: 20,
    focus: false
  },
  bindButtonTap: function() {
    this.setData({
      focus: true
    })
  },
  bindTextAreaBlur: function(e) {
    console.log(e.detail.value)
  },
  bindFormSubmit: function(e) {
    console.log(e.detail.value.textarea)
  }
})