@tarojs/components

import { ComponentType } from 'react' import { StandardProps, CommonEventFunction, FormItemProps } from './common' interface TextareaProps extends StandardProps, FormItemProps { /** 输入框的内容 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid */ value?: string /** 设置 React 非受控输入框的初始内容 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid * @unique */ defaultValue?: string /** 输入框为空时占位符 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid */ placeholder?: string /** 指定 placeholder 的样式 * @supported weapp, alipay, swan, tt, qq, jd, harmony */ placeholderStyle?: string /** 指定 placeholder 的样式类 * @default "textarea-placeholder" * @supported weapp, alipay, swan, tt, qq, jd */ placeholderClass?: string /** 是否禁用 * @default false * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid */ disabled?: boolean /** 最大输入长度，设置为 -1 的时候不限制最大长度 * @default 140 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid */ maxlength?: number /** 自动聚焦，拉起键盘 * @default false * @supported weapp, swan, qq, jd, h5, harmony_hybrid */ autoFocus?: boolean /** 获取焦点 * @default false * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid */ focus?: boolean /** 是否自动增高，设置 autoHeight 时，style.height不生效 * @default false * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid */ autoHeight?: boolean /** 如果 Textarea 是在一个 `position:fixed` 的区域，需要显示指定属性 fixed 为 true * @default false * @supported weapp, swan, qq, jd */ fixed?: boolean /** 指定光标与键盘的距离，单位 px 。取 Textarea 距离底部的距离和 cursorSpacing 指定的距离的最小值作为光标与键盘的距离 * @default 0 * @supported weapp, swan, tt, qq, jd */ cursorSpacing?: number /** 指定 focus 时的光标位置 * @default -1 * @supported weapp, swan, tt, qq, jd */ cursor?: number /** 是否显示键盘上方带有”完成“按钮那一栏 * @default true * @supported weapp, swan, tt, qq, jd */ showConfirmBar?: boolean /** 光标起始位置，自动聚集时有效，需与 selectionEnd 搭配使用 * @default -1 * @supported weapp, swan, tt, qq, jd, rn */ selectionStart?: number /** 光标结束位置，自动聚集时有效，需与 selectionStart 搭配使用 * @default -1 * @supported weapp, swan, tt, qq, jd, rn */ selectionEnd?: number /** 键盘弹起时，是否自动上推页面 * @default true * @supported weapp, swan, tt, qq, jd */ adjustPosition?: boolean /** focus 时，点击页面的时候不收起键盘 * @default false * @supported weapp, tt */ holdKeyboard?: boolean /** 是否去掉 iOS 下的默认内边距 * @default false * @supported weapp, tt */ disableDefaultPadding?: boolean /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上 * @supported h5, harmony_hybrid */ nativeProps?: Record<string, unknown> /** 设置键盘右下角按钮的文字 * @supported weapp, alipay, swan, tt */ confirmType?: 'send' | 'search' | 'next' | 'go' | 'done' | 'return' /** 点击键盘右下角按钮时是否保持键盘不收起 * @supported weapp, swan, tt */ confirmHold?: boolean /** 组件名字，用于表单提交获取数据。 * @supported alipay */ name?: string /** 是否渲染字数统计功能（是否删除默认计数器/是否显示字数统计）。 * @default true * @supported alipay */ showCount?: boolean /** 是否为受控组件。为 true 时，value 内容会完全受 setData 控制。 * @default false * @supported alipay */ controlled?: boolean /** 无障碍访问，（属性）元素的额外描述 * @supported qq */ ariaLabel?: string /** 键盘对齐位置 * @supported weapp * @default false */ adjustKeyboardTo?: boolean /** 输入框聚焦时触发 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid */ onFocus?: CommonEventFunction<TextareaProps.onFocusEventDetail> /** 输入框失去焦点时触发 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid */ onBlur?: CommonEventFunction<TextareaProps.onBlurEventDetail> /** 输入框行数变化时调用 * @supported weapp, swan, tt, qq, jd, rn */ onLineChange?: CommonEventFunction<TextareaProps.onLineChangeEventDetail> /** 当键盘输入时，触发 input 事件 * * **onInput 处理函数的返回值并不会反映到 textarea 上** * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid */ onInput?: CommonEventFunction<TextareaProps.onInputEventDetail> /** 点击完成时，触发 confirm 事件 * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid */ onConfirm?: CommonEventFunction<TextareaProps.onConfirmEventDetail> /** 键盘高度发生变化的时候触发此事件 * @supported weapp, tt, harmony */ onKeyboardHeightChange?: CommonEventFunction<TextareaProps.onKeyboardHeightChangeEventDetail> } declare namespace TextareaProps { interface onFocusEventDetail { /** 输入值 */ value: string /** 键盘高度 */ height: number } interface onBlurEventDetail { /** 输入值 */ value: string /** 光标位置 */ cursor: number } interface onLineChangeEventDetail { height: number heightRpx: number lineCount: number } interface onInputEventDetail { /** 输入值 */ value: string /** 光标位置 */ cursor: number /** 键值 */ keyCode: number } interface onConfirmEventDetail { /** 输入值 */ value: string } interface onKeyboardHeightChangeEventDetail { /** 键盘高度 */ height: number /** 持续时间 */ duration: number } } /** 多行输入框。该组件是原生组件，使用时请注意相关限制 * @classification forms * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid * @example_react * ```tsx * export default class PageView extends Component { * constructor() { * super(...arguments) * } * * render() { * return ( * <View className='components-page'> * <Text>输入区域高度自适应，不会出现滚动条</Text> * <Textarea style='background:#fff;width:100%;min-height:80px;padding:0 30rpx;' autoHeight/> * <Text>这是一个可以自动聚焦的 textarea</Text> * <Textarea style='background:#fff;width:100%;height:80px;padding:0 30rpx;' autoFocus/> * </View> * ) * } * } * ``` * @example_vue * ```html * <template> * <view class="components-page"> * <text>输入区域高度自适应，不会出现滚动条</text> * <textarea style="background:#efefef;width:100%;min-height:80px;padding:0 30rpx;" :auto-height="true" /> * <text>这是一个可以自动聚焦的 textarea</text> * <textarea style="background:#efefef;width:100%;height:80px;padding:0 30rpx;" :auto-focusd="true" /> * </view> * </template> * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/component/textarea.html */ declare const Textarea: ComponentType<TextareaProps> export { Textarea, TextareaProps }