@opensig/opendesign
Version:
157 lines (156 loc) • 4.31 kB
TypeScript
import { BaseScrollerPropsT } from '../..//scrollbar';
import { ExtractPropTypes, PropType } from 'vue';
export declare const TextareaResizeTypes: readonly ["both", "horizontal", "h", "vertical", "v", "none"];
export type TextareaResizeT = (typeof TextareaResizeTypes)[number];
export declare const inTextareaProps: {
/**
* @zh-CN 双向绑定值
* @en-US Two-way binding value
*/
modelValue: {
type: StringConstructor;
};
/**
* @zh-CN 非受控默认值
* @en-US Non-controlled default value
*/
defaultValue: {
type: StringConstructor;
};
/**
* @zh-CN 提示文本
* @en-US Prompt text
*/
placeholder: {
type: StringConstructor;
};
/**
* @zh-CN 是否禁用
* @en-US Whether to disable
*/
disabled: {
type: BooleanConstructor;
};
/**
* @zh-CN 是否只读
* @en-US Whether to read-only
*/
readonly: {
type: BooleanConstructor;
};
/**
* @zh-CN 是否可以清除
* @en-US Whether to clear
*/
clearable: {
type: BooleanConstructor;
};
/**
* @zh-CN 格式化函数,控制显示格式
* @en-US Format function, control display format
*/
format: {
type: PropType<(value: string) => string>;
};
/**
* @zh-CN 校验函数
* @en-US Validation function
*/
validate: {
type: PropType<(value: string) => boolean>;
};
/**
* @zh-CN 输入为无效值时,在blur/pressEnter时的回调,返回值为纠正后的值;当输入值不合法时的处理方式:[true]:纠正为上一次合法的值(如果上一次合法值为空字符串,则不处理); [false|undefined]: 不处理;[function]: 使用函数的返回值
* @en-US When the input value is an invalid value, the callback during blur/pressEnter returns the corrected value.
*/
valueOnInvalidChange: {
type: PropType<boolean | ((inputValue: string, lastValidInputValue: string) => string)>;
};
/**
* @zh-CN 同 textarea 的 rows 属性
* @en-US The rows attribute of textarea
*/
rows: {
type: NumberConstructor;
default: number;
};
/**
* @zh-CN 同 textarea 的 cols 属性
* @en-US The cols attribute of textarea
*/
cols: {
type: NumberConstructor;
default: undefined;
};
/**
* @zh-CN 是否支持调整尺寸
* @en-US Whether to support resizing
* @default 'vertical'
*/
resize: {
type: PropType<TextareaResizeT>;
default: string;
};
/**
* @zh-CN 字符最小长度
* @en-US Minimum length of characters
*/
minLength: {
type: NumberConstructor;
};
/**
* @zh-CN 字符最大长度
* @en-US Maximum length of characters
*/
maxLength: {
type: NumberConstructor;
};
/**
* @zh-CN 是否显示字符长度信息,always: 一直显示; never:不显示;auto:设置了minLength、maxLength时显示
* @en-US if not show character length.
*/
showLength: {
type: PropType<"always" | "auto" | "never">;
default: string;
};
/**
* @zh-CN 获取长度方法
* @en-US The method of getting length
*/
getLength: {
type: PropType<(val: string) => number>;
};
/**
* @zh-CN 超过最大字符长度时是否允许输入
* @en-US Whether to allow input when exceeding the maximum character length
* @default true
*/
inputOnOutlimit: {
type: BooleanConstructor;
default: boolean;
};
/**
* @zh-CN 根据内容自动计算高度
* @en-US Whether to automatically calculate height based on content
*/
autoSize: {
type: BooleanConstructor;
};
/**
* @zh-CN id, 用于关联label
* @en-US id, for associating label
*/
textareaId: {
type: StringConstructor;
};
/**
* @zh-CN scrollbar配置
* @en-US scrollbar configuration
* @default true
*/
scrollbar: {
type: PropType<boolean | Partial<BaseScrollerPropsT>>;
default: boolean;
};
};
export type inTextareaPropsT = ExtractPropTypes<typeof inTextareaProps>;