inputField

来自于：官方立即使用

open setInputFieldListener close show hide becomeFirstResponder resignFirstResponder setMsg getMsg configMsg insertMsg setPlaceholder

概述

inputField 是一个输入框，开发者可根据需求自定义其样式。该模块能巧妙的适配键盘高度，自定调整位置，始终紧贴软键盘

inputField - 图1

open

打开输入框

open({parmas}, callback(ret, err))

params

inputFieldH:

  • 类型：数字类型
  • 描述：（可选项）输入视图的高度，本参数暂仅支持iOS平台
  • 默认值：50

bgColor:

  • 类型：字符串
  • 描述：（可选项）输入视图背景色设置，支持 rgba、rgb、#
  • 默认值：#696969

lineColor:

  • 类型：字符串
  • 描述：（可选项）输入框视图最上边的分割线色设置，支持 rgba、rgb、#
  • 默认值：#000

inputTextSize:

  • 类型：数字
  • 描述：输入框字体大小
  • 默认：14

inputPaddingVertical：

  • 类型：数字
  • 描述：垂直方向内边距 注意:iOS本身无此参数，所以不支持
  • 默认：3

inputPaddingHorizental:

  • 类型：数字
  • 描述：水平方向内边距 注意:iOS本身无此参数，所以不支持
  • 默认：3

inputCorner：

  • 类型：数字
  • 描述：（可选项）输入框的圆角
  • 默认值：5

inputBorderWidth：

  • 类型：数字
  • 描述：（可选项）边框的宽度

lineBottomColor:

  • 类型：字符串
  • 描述：（可选项）输入框视图最下边的分割线色设置，支持 rgba、rgb、#，本参数暂仅支持iOS平台
  • 默认值：无色

borderColor:

  • 类型：字符串
  • 描述：（可选项）输入框边框色设置，支持 rgba、rgb、#
  • 默认值：#ff0000

fileBgColor:

  • 类型：字符串
  • 描述：（可选项）输入框背景色设置，支持 rgba、rgb、#
  • 默认值：#fff

leftImg:

  • 类型：字符串
  • 描述：左边按钮的背景图片，本参数暂仅支持iOS平台

sendImg:

  • 类型：字符串
  • 描述：发送按钮的背景图片，要求50*40规格的图片（宽-高）

sendImgHighlight：

  • 类型：字符串
  • 描述：（可选项）发送按钮的高亮背景图片，要求50*40规格的图片（宽-高）

maxLines：

  • 类型：数字
  • 描述：（可选项）输入框高度自适应输入的文字行数的最大限高值
  • 备注：若不传则高度不自适应

limitedWordsNumber：

  • 类型：数字
  • 描述：（可选项）输入框限制文字字数
  • 备注：若不传则文字字数不做限制

placeholder：

  • 类型：字符串
  • 描述：（可选项）输入框的提示文字
  • 备注：若不传则不显示占位提示文字

autoFocus：

  • 类型：布尔
  • 描述：（可选项）输入框是否自动获取焦点，并弹出键盘
  • 默认值：false

sendBtn：

  • 类型：JSON 对象
  • 描述：（可选项）发送按钮配置，若本参数有值，则模块忽略sendImg、sendImgHighlight
  • 内部字段：
  1. {
  2.      bg: '#f00',          //字符串类型；发送按钮常态背景色
  3.      inputBg:'#ff0',      //(可选项)字符串类型；当输入文字发时送按钮的背景色；默认：bg的色值
  4.      bgHighlight: '#000', //字符串类型；发送按钮点击时的高亮背景色
  5.      title: '发送',        //字符串类型；发送按钮的标题
  6.      titleSize: 10,       //数字类型；发送按钮的标题字体大小
  7.      titleColor: '#fff',  //字符串类型；发送按钮标题文字颜色  
  8.      corner: 5,           //数字类型；发送按钮圆角大小
  9.      sendW:40,            //数字类型；发送按钮的宽
  10.      sendH:30,            //数字类型；发送按钮的高
  11.      marginRight:10,      //数字类型；发送按钮距离屏幕右边的距离，本参数暂仅支持iOS平台；默认：10
  12. }

leftBtn：

  • 类型：JSON 对象
  • 描述：（可选项）左边按钮配置，若本参数有值，则模块忽略leftImg，本参数暂仅支持iOS平台
  • 内部字段：
  1. {
  2.      bg: '#f00',           //字符串类型；左边按钮常态背景色
  3.      bgHighlight: '#000',  //字符串类型；右边按钮点击时的高亮背景色
  4.      title: '添加',         //字符串类型；左边按钮的标题
  5.      titleSize: 10,        //数字类型；左边按钮的标题字体大小
  6.      titleColor: '#fff',   //字符串类型；左边按钮标题文字颜色  
  7.      corner: 5,            //数字类型；左边按钮圆角大小
  8.      leftW:40,             //数字类型；左边按钮的宽
  9.      leftH:30 ,            //数字类型；左边按钮的高
  10. }

placeholderStyles：

  • 类型：JSON 对象
  • 描述：（可选项）占位文字样式配置
  • 内部字段：
  1. {
  2.      color: '#fff',     //字符串类型；占位文字颜色，支持rgb、rgba、#；默认：#696969 
  3.      size: 13,          //数字类型；占位文字大小；默认：13
  4.      marginL: 5         //数字类型；占位文字距离左边的大小；默认：5
  5. }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:'',          //字符串类型；返回输入的文字
  3.     leftBtn: 'click' //字符串类型；点击左边按钮，本参数暂仅支持iOS平台
  4. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.open({
  3.     bgColor: '#708090',
  4.     lineColor: '#C71585',
  5.     fileBgColor: '#90EE90',
  6.     borderColor: '#FFB6C1',
  7.     sendImg: 'widget://res/img/sendImg.png',
  8.     fixedOn: api.frameName
  9. }, function(ret, err) {
  10.     if (ret) {
  11.         alert(JSON.stringify(ret));
  12.     } else {
  13.         alert(JSON.stringify(err));
  14.     }
  15. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setInputFieldListener

设置输入框监听

setInputFieldListener(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.      eventType:        //字符串类型；输入框弹动事件，取值范围如下：
  3.                        //move：输入框弹动事件
  4.                        //change    ：输入框高度改变事件
  5.      inputFieldH：     //数字类型；输入框的高度
  6.      chatViewH：       //数字类型；输入框下边缘距离屏幕底边的高度
  8. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.setInputFieldListener(function(ret, err) {
  3.     if (ret) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.1及更高版本

close

关闭输入框

close(callback(ret, err));

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:           //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.close();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

hide

隐藏输入框，并没有从内存里清除

hide(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:          //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.hide(function(ret, err) {
  3.     if (ret) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

show

显示输入框

show(callback(ret, err));

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:           //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.show();

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

becomeFirstResponder

弹出键盘

becomeFirstResponder(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:          //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.becomeFirstResponder(function(ret, err) {
  3.     if (ret.status) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

resignFirstResponder

隐藏键盘

resignFirstResponder(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:         //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.resignFirstResponder();

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

setMsg

设置输入框内的文字

setMsg({params},callback( ret, err))

params

msg：

  • 类型：字符串
  • 描述：（可选项）要设置的输入框内的文字内容
  • 默认值：空字符串

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:          //布尔类型；操作状态码，true|false
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.setMsg({
  3.     msg: '设置的文字'
  4. }, function(ret, err) {
  5.     if (ret.status) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

getMsg

获取当前输入框内的文字

setMsg(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:           // 字符串类型，获取到的当前输入框内的文字
  3. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.getMsg(function(ret, err) {
  3.     if (ret) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

configMsg

配置当前输入框内的文字

configMsg({params}, callback(ret, err))

params

msg：

  • 类型：字符串
  • 描述：（可选项）要设置的输入框内的文字内容
  • 备注：若不传则此接口 callBack 当前值

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.         status:           // 布尔类型；操作是否成功状态值
  3.         msg:              // 字符串类型；获取到的当前输入框内的文字
  4. }

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.configMsg(function(ret, err) {
  3.     if (ret.status) {
  4.         alert(JSON.stringify(ret));
  5.     } else {
  6.         alert(JSON.stringify(err));
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

insertMsg

向当前输入框内指定位置插入字符串

insertMsg({params})

params

index：

  • 类型：数字
  • 描述：（可选项）插入当前输入框内字符串的位置
  • 默认值：当前输入框内字符串的长度

msg：

  • 类型：字符串
  • 描述：（可选项）要设置的输入框内的文字内容
  • 默认值：空字符串

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.insertMsg({
  3.     msg: '这里是插入的字符串'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本

setPlaceholder

设置占位提示文字

setPlaceholder({params})

params

placeholder：

  • 类型：字符串
  • 描述：（可选项）占位提示文字
  • 备注：若不传或传空则表示清空占位提示文字

示例代码

  1. var inputField = api.require('inputField');
  2. inputField.setPlaceholder({
  3.     placeholder: '我是占位提示文字'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.2及更高版本