From 50f52ec765059ce396c2ef738d80bb34cb917134 Mon Sep 17 00:00:00 2001 From: woodyjang Date: Tue, 5 Sep 2017 17:33:15 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=9E=E4=BE=8B=E7=BB=84=E4=BB=B6=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- uidoc/base/bubble.md | 8 ++-- uidoc/base/button/button.md | 30 ++++++------- uidoc/base/button/icon_button.md | 4 +- uidoc/base/button/image_button.md | 6 +-- uidoc/base/button/text_button.md | 12 ++--- uidoc/base/canvas.md | 4 +- uidoc/base/editor/code_editor.md | 6 +-- uidoc/base/editor/editor.md | 22 ++++----- uidoc/base/editor/formula_editor.md | 20 ++++----- uidoc/base/editor/multifile_editor.md | 6 +-- uidoc/base/editor/textarea_editor.md | 2 +- uidoc/base/label.md | 30 ++++++------- uidoc/base/message.md | 2 +- uidoc/base/pager.md | 26 +++++------ uidoc/base/svg.md | 6 +-- uidoc/base/toast.md | 6 +-- uidoc/case/combo/bubble_combo.md | 6 +-- uidoc/case/combo/formula_combo.md | 4 +- uidoc/case/combo/icon_combo.md | 10 ++--- uidoc/case/combo/static_combo.md | 6 +-- uidoc/case/combo/text_value_downlist_combo.md | 2 +- uidoc/case/editor/shelter_editor.md | 22 ++++----- uidoc/case/editor/sign_editor.md | 20 ++++----- uidoc/case/editor/sign_initial_editor.md | 22 ++++----- uidoc/case/editor/state_editor.md | 20 ++++----- uidoc/case/layer/pane_list.md | 14 +++--- uidoc/case/layer/panel.md | 2 +- uidoc/core/abstract/button_group.md | 11 ++--- uidoc/core/abstract/collection_view.md | 12 ++--- uidoc/core/abstract/custom_tree.md | 8 ++-- uidoc/core/abstract/grid_view.md | 19 ++++---- uidoc/core/abstract/virtual_group.md | 6 +-- uidoc/core/abstract/virtual_list.md | 6 +-- uidoc/core/basic_button.md | 4 +- uidoc/core/combination/bi.combo.md | 14 +++--- uidoc/core/combination/bi.expander.md | 19 ++++---- uidoc/core/combination/group_combo.md | 8 ++-- uidoc/core/combination/loader.md | 12 ++--- uidoc/core/combination/navigation.md | 9 ++-- uidoc/core/combination/searcher.md | 18 ++++---- uidoc/core/combination/switcher.md | 10 ++--- uidoc/core/combination/tab.md | 7 ++- uidoc/core/layer/layer_popup.md | 14 +++--- uidoc/core/layout/border.md | 2 +- uidoc/core/layout/center.md | 14 +++--- uidoc/core/layout/center_adapt.md | 15 +++---- uidoc/core/layout/float_center.md | 14 +++--- uidoc/core/layout/flow.md | 14 +++--- uidoc/core/layout/grid.md | 8 ++-- uidoc/core/layout/horizontal.md | 17 ++++--- uidoc/core/layout/horizontal_adapt.md | 19 ++++---- uidoc/core/layout/horizontal_auto.md | 14 +++--- uidoc/core/layout/horizontal_float.md | 16 +++---- uidoc/core/layout/htape.md | 14 +++--- .../core/layout/left_right_vertical_adapt.md | 18 ++++---- uidoc/core/layout/vertical.md | 13 +++--- uidoc/core/layout/vertical_adapt.md | 15 +++---- uidoc/core/layout/vtape.md | 14 +++--- uidoc/core/pane.md | 2 +- uidoc/core/single.md | 8 ++-- uidoc/core/widget.md | 16 +++---- uidoc/detailed/bi.button/general.md | 1 - uidoc/detailed/bi.button/items.md | 20 ++++----- uidoc/detailed/bi.button/node.md | 24 +++++----- uidoc/detailed/bi.button/segment.md | 24 +++++----- uidoc/detailed/bi.button/tooltip.md | 25 ++++++----- uidoc/detailed/text_input/bi.clear_editor.md | 33 +++++++------- uidoc/detailed/text_input/bi.search_editor.md | 34 +++++++------- uidoc/detailed/text_input/bi.text_editor.md | 45 ++++++++++--------- .../text_input/finetuning_number_editor.md | 13 ++++-- 70 files changed, 473 insertions(+), 474 deletions(-) diff --git a/uidoc/base/bubble.md b/uidoc/base/bubble.md index 470a51cea..bd138066d 100644 --- a/uidoc/base/bubble.md +++ b/uidoc/base/bubble.md @@ -25,9 +25,9 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :---- |:---- -| direction | 气泡显示位置 | string | | "top" | -| height | 气泡高度 | number | | 35 | -| text | 气泡显示内容 | string | | " " | +| direction | 气泡显示位置 | string | — | "top" | +| height | 气泡高度 | number | — | 35 | +| text | 气泡显示内容 | string | — | " " | @@ -36,5 +36,5 @@ BI.createWidget({ | :------ |:------------- | :----- | setText | 设置文本值 | 需要设置的文本值text| ---- + --- \ No newline at end of file diff --git a/uidoc/base/button/button.md b/uidoc/base/button/button.md index 9a3211fcc..0f600054b 100644 --- a/uidoc/base/button/button.md +++ b/uidoc/base/button/button.md @@ -25,35 +25,33 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | | +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | ##### 高级属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | level |按钮类型 | string| common,success,warning,ignore | common | -| text|按钮文本内容 | string| | | -| disabled|灰化 | boolean| true,false | | -| minWidth | 最小宽度，如果block/clear中某一项为true，此项值为0，否则为90 | number | | 90 | -| shadow | | boolean| true,false | | +| minWidth | 最小宽度，如果block/clear中某一项为true，此项值为0，否则为90 | number | — | 90 | +| shadow | | boolean| true,false | | | isShadowShowingOnSelected|选中状态下是否显示阴影 | boolean| true,false | true | | readonly | 是否只读 | boolean | true,false | true | -| iconClass | 图标类型 | string| | " "| +| iconClass | 图标类型 | string| — | " "| | block| 是否块状显示，即不显示边框，没有最小宽度的限制 | boolean| true,false | false | | clear| 是否去掉边框和背景 |boolean| true,false | false | | textAlign | 文字布局 | string | left,center,right | cneter | | whiteSpace | 元素内的空白处理方式 | string | normal,nowrap | nowrap| | forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | false | -| textWidth| 按钮文本宽度 | number| | null | -| textHeight | 按钮文本高度 | number| | null | +| textWidth| 按钮文本宽度 | number| — | null | +| textHeight | 按钮文本高度 | number| — | null | ## 对外方法 | 名称 | 说明 | 回调参数 diff --git a/uidoc/base/button/icon_button.md b/uidoc/base/button/icon_button.md index e7e343e87..e98fd0821 100644 --- a/uidoc/base/button/icon_button.md +++ b/uidoc/base/button/icon_button.md @@ -24,8 +24,8 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| iconWidth | 图标宽度 | number| | null | -| iconHeight | 图标高度 | number| | null | +| iconWidth | 图标宽度 | number| — | null | +| iconHeight | 图标高度 | number| — | null | ## 对外方法 diff --git a/uidoc/base/button/image_button.md b/uidoc/base/button/image_button.md index 7c7f3b97f..75749dea2 100644 --- a/uidoc/base/button/image_button.md +++ b/uidoc/base/button/image_button.md @@ -24,9 +24,9 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| src |图片路径 |string | |" " | -| iconWidth | 图标宽度 | number/string| | "100%" | -| iconHeight | 图标高度 | number/string | | "100%"| +| src |图片路径 |string | —|" " | +| iconWidth | 图标宽度 | number/string| — | "100%" | +| iconHeight | 图标高度 | number/string | — | "100%"| ## 对外方法 diff --git a/uidoc/base/button/text_button.md b/uidoc/base/button/text_button.md index e0225c1c5..314f6f4fb 100644 --- a/uidoc/base/button/text_button.md +++ b/uidoc/base/button/text_button.md @@ -23,12 +23,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | | 10 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| text|按钮文本内容 | string| | | -| textWidth| 按钮文本宽度 | number| | null | -| textHeight | 按钮文本高度 | number| | null | +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | — | 10 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| text|按钮文本内容 | string| — | — | +| textWidth| 按钮文本宽度 | number| — | null | +| textHeight | 按钮文本高度 | number| — | null | ##### 高级属性 diff --git a/uidoc/base/canvas.md b/uidoc/base/canvas.md index 95e08ee29..7c08f96af 100644 --- a/uidoc/base/canvas.md +++ b/uidoc/base/canvas.md @@ -29,8 +29,8 @@ canvas.stroke(); | line | 绘制线段| (x0, y0, x1, y1) | | rect | 绘制矩形 | (x,y,w,h,color)分别表示左上角的横坐标、纵坐标，矩形宽、高、以及绘制的颜色| | circle | 绘制圆形 | (x, y, radius, color)分别表示原点的横坐标，纵坐标，半径以及颜色 | -| hollow | 填充中空的路径 | | -| solid | 填充实心的路径 | | +| hollow | 填充中空的路径 | — | +| solid | 填充实心的路径 | — | | gradient | 绘制渐变色 | (x0, y0, x1, y1, start, end) | | reset | 重置画布 | —| | stroke | 绘制 | callback | diff --git a/uidoc/base/editor/code_editor.md b/uidoc/base/editor/code_editor.md index 2adf0bdd3..9a17529e1 100644 --- a/uidoc/base/editor/code_editor.md +++ b/uidoc/base/editor/code_editor.md @@ -24,11 +24,11 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| watermark | 文本框placeholder | string | | " " | +| watermark | 文本框placeholder | string | — | " " | | readOnly | 是否只读 | boolean | true,false | false| | lineHeight | 行高 | number|— | 2| -| value | 文本框值| string| | " "| -| paramFormatter| 参数显示值构造函数 | function| | value | +| value | 文本框值| string| —| " "| +| paramFormatter| 参数显示值构造函数 | function| — | value | diff --git a/uidoc/base/editor/editor.md b/uidoc/base/editor/editor.md index 58902e6e0..841006a19 100644 --- a/uidoc/base/editor/editor.md +++ b/uidoc/base/editor/editor.md @@ -25,20 +25,20 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | -| watermark | 文本框placeholder | string | | " " | -| errorText | 错误提示 | string/function | | " "| +| watermark | 文本框placeholder | string | — | " " | +| errorText | 错误提示 | string/function | —| " "| | tipType| 提示类型 | string |success,warning | "warning"| -| inputType| 输入框类型| string| | "text"| +| inputType| 输入框类型| string| 参考input输入框类型 | "text"| diff --git a/uidoc/base/editor/formula_editor.md b/uidoc/base/editor/formula_editor.md index 9509c3717..8f6a83393 100644 --- a/uidoc/base/editor/formula_editor.md +++ b/uidoc/base/editor/formula_editor.md @@ -26,11 +26,11 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| value | 文本域的值 | string | | " "| -| watermark | 文本框placeholder| string | | " " | -| fieldTextValueMap | | string| | {}| -| showHint | | | | 2 | -| lineHeight | 行高 | number | | 2| +| value | 文本域的值 | string | — | " "| +| watermark | 文本框placeholder| string | —| " " | +| fieldTextValueMap | | string| —| {}| +| showHint | | | —| 2 | +| lineHeight | 行高 | number | —| 2| @@ -40,12 +40,12 @@ BI.createWidget({ | disableWaterMark | 设置文本框placeholder不可用 | — | | focus | 文本框获取焦点| — | | insertField | 添加字段 | field | -| insertFunction | | fn | -| insertOperator | | op| -| setFunction | | v| +| insertFunction | 插入函数 | fn | +| insertOperator | 插入操作符| op| +| setFunction | 设置函数 | v| | insertString | 插入字符串 | str| -| getFormulaString | |— | -| getUsedFields | | — | +| getFormulaString | 获取公式 |— | +| getUsedFields | 获取可用字段 | — | | getCheckString | | — | | getValue | 获取文本框值|—| | setValue | 设置文本框值|value| diff --git a/uidoc/base/editor/multifile_editor.md b/uidoc/base/editor/multifile_editor.md index 896dfad03..d2c41a474 100644 --- a/uidoc/base/editor/multifile_editor.md +++ b/uidoc/base/editor/multifile_editor.md @@ -24,9 +24,9 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | multiple | 是否支持多选 | boolean | true,false| false | -| maxSize | 最大可选数量 | number | | -1 | -| accept | | string | | " "| -| url | 文件路径 | string | | " "| +| maxSize | 最大可选数量 | number |— | -1 | +| accept | | string | —| " "| +| url | 文件路径 | string | —| " "| diff --git a/uidoc/base/editor/textarea_editor.md b/uidoc/base/editor/textarea_editor.md index 23bcc61f2..a22005163 100644 --- a/uidoc/base/editor/textarea_editor.md +++ b/uidoc/base/editor/textarea_editor.md @@ -23,7 +23,7 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| value | 文本域的值 | string | | " "| +| value | 文本域的值 | string | — | " "| diff --git a/uidoc/base/label.md b/uidoc/base/label.md index ac6945682..6aaeb9b1c 100644 --- a/uidoc/base/label.md +++ b/uidoc/base/label.md @@ -26,15 +26,15 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| textWidth | 文本标签宽度 | number| | null | -| textHeight | 文本标签宽度 | number| | null | -| text | 文本内容 | string | | " " | +| hgap | 效果相当于容器左右padding值 | number | —| 0 | +| vgap | 效果相当于容器上下padding值 | number | —| 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | —| 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| textWidth | 文本标签宽度 | number| — | null | +| textHeight | 文本标签宽度 | number| — | null | +| text | 文本内容 | string | — | " " | ##### 高级属性 @@ -44,11 +44,11 @@ BI.createWidget({ | textAlign | 文本对齐方式 | string | left,center,right | center | | whiteSpace | 元素内空白处理方式 | string| normal,nowrap | nowrap| | forceCenter | 是否无论如何都要居中, 不考虑超出边界的情况, 在未知宽度和高度时有效 | boolean | true,false | true | -| py | | string | | 空 | -| keyword | | string | | 空 | +| py | | string | — | 空 | +| keyword | | string | —| 空 | | disabled | 灰化 | boolean| true,false | 无 | -| title | 提示title | string | | 空 | -| warningTitle | 错误提示title | string | | 空 | +| title | 提示title | string | — | 空 | +| warningTitle | 错误提示title | string | — | 空 | ## 对外方法 | 名称 | 说明 | 回调参数 @@ -64,8 +64,4 @@ BI.createWidget({ | populate| | —| - - - - --- \ No newline at end of file diff --git a/uidoc/base/message.md b/uidoc/base/message.md index 5aed5c11f..ae2532e23 100644 --- a/uidoc/base/message.md +++ b/uidoc/base/message.md @@ -3,7 +3,7 @@ #### 消息提示 {% method %} -[source]() +[source](https://jsfiddle.net/fineui/feu8kf4u/) {% common %} ```javascript diff --git a/uidoc/base/pager.md b/uidoc/base/pager.md index b398589ab..d26530586 100644 --- a/uidoc/base/pager.md +++ b/uidoc/base/pager.md @@ -27,23 +27,23 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| behaviors | | object| | {}| -| layouts | 布局| array | | {type:"bi.horizontal",hgap:10,vgap:0} | +| behaviors | 自定义列表中item项的行为，如高亮，标红等 | object| — | {}| +| layouts | 布局| array |— | {type:"bi.horizontal",hgap:10,vgap:0} | | dynamicShow | 是否动态显示上一页、下一页、首页、尾页， 若为false，则指对其设置使能状态 | boolean| true,false | true| | dynamicShowFirstLast | 是否动态显示首页、尾页,dynamicShow为false时生效| boolean| true,false | false | | dynamicShowPrevNext | 是否动态显示上一页、下一页,dynamicShow为false时生效 | boolean| true,false | false| | pages | 是否显示总页数 | boolean| true,false|false| -| curr | 初始化当前页 | function | | function(){return 1;}| -| groups | 连续显示分页数 | number | | 0 | -| jump | 页数跳转| function | | | +| curr | 初始化当前页 | function | —| function(){return 1;}| +| groups | 连续显示分页数 | number | — | 0 | +| jump | 页数跳转| function |— | —| | first | 是否显示首页 | boolean | true,false| false| | last | 是否显示尾页 | boolean | true,false| false| -| prev | 上一页 | string,object | |"上一页" | -| next | 下一页 | sting,object| | "下一页" | -| firstPage | 第一页 | number| | 1 | -| lastPage | 最后一页,在万不得已时才会调用这个函数获取最后一页的页码, 主要作用于setValue方法 | function | | function(){ return 1;}| -| hasPrev | 判断是否有上一页,pages不可用时有效 | function | | — | -| hasNext | 判断是否有下一页,pages不可用时有效 | function | | — | +| prev | 上一页 | string,object —| — |"上一页" | +| next | 下一页 | sting,object| —| "下一页" | +| firstPage | 第一页 | number|— | 1 | +| lastPage | 最后一页,在万不得已时才会调用这个函数获取最后一页的页码, 主要作用于setValue方法 | function | —| function(){ return 1;}| +| hasPrev | 判断是否有上一页,pages不可用时有效 | function | —| — | +| hasNext | 判断是否有下一页,pages不可用时有效 | function |— | — | ## 对外方法 @@ -54,9 +54,9 @@ BI.createWidget({ | hasPrev | 判断是否有上一页 | v | | hasNext | 判断是否有下一页 | v | | setValue | 设置当前页码 | v | -| getValue | 获取当前页码 | | +| getValue | 获取当前页码 | —| | attr | 设置属性 | key,value | -| populate | | —| +| populate | 刷新或者清空列表| —| ## 事件 | 名称 | 说明 | diff --git a/uidoc/base/svg.md b/uidoc/base/svg.md index a55f141e2..6724b4fc9 100644 --- a/uidoc/base/svg.md +++ b/uidoc/base/svg.md @@ -34,15 +34,15 @@ svg.path("M10,10L50,50M50,10L10,50") | ellipse | 绘制椭圆 |(x,y,rx,ry)分别表示原点的横、纵坐标，以及水平半径和垂直半径| | text | 绘制文本 | (x,y,text)分别表示绘制的原点横、纵坐标以及要绘制的文本内容| | print | 根据制定参数打印出路径 | (x, y, string, font, size, origin, letter_spacing, line_spacing) | -| setStart | 开始绘制 | | -| setFinish | 结束绘制 | | +| setStart | 开始绘制 | — | +| setFinish | 结束绘制 | — | | setSize | 设置画布尺寸 | (width,height)分别表示画布宽高| | setViewBox | 设置画布可视区域 | (x,y,width,height,fit)分别表示可视区域原点坐标以及可视区域宽高，以及是否根据可视区域进行调整 | | getById | 根据id返回元素 | id | | getElementByPoint | 获根据给定的点坐标返回元素 | (x,y)| | getElementsByPoint | 获根据给定的点坐标返回元素 | (x,y) | | getFont | 通过给定的参数在已注册的字体中找到字体对象 | (family, weight, style, stretch) | -| set | 绘制形状的集合 | | +| set | 绘制形状的集合 | — | | remove | 设置总页数 | pages | | clear | 判断是否有上一页 | v | diff --git a/uidoc/base/toast.md b/uidoc/base/toast.md index d94a421c6..b889aa92c 100644 --- a/uidoc/base/toast.md +++ b/uidoc/base/toast.md @@ -3,7 +3,7 @@ #### toast提示 {% method %} -[source]() +[source](https://jsfiddle.net/fineui/wop751sg/) {% common %} ```javascript @@ -28,8 +28,8 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :---- |:---- | level | 提示类型 | string | success,warning | "success" | -| height | 高度 | number | | 30 | -| text | 显示内容 | string | | " " | +| height | 高度 | number | — | 30 | +| text | 显示内容 | string | — | " " | diff --git a/uidoc/case/combo/bubble_combo.md b/uidoc/case/combo/bubble_combo.md index 2a8bd56f1..c35d143df 100644 --- a/uidoc/case/combo/bubble_combo.md +++ b/uidoc/case/combo/bubble_combo.md @@ -41,8 +41,8 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| text | | string | | "" | -| value | 组件value值 | string | |""| +| text | 组件text值 | string | —| "" | +| value | 组件value值 | string |— |""| | stopEvent | 阻止事件 |boolean | true,false | false | | stopPropagation | 阻止冒泡 | boolean | true,false| false | | selected | button的选中状态 | boolean | true,false |false | @@ -53,7 +53,7 @@ BI.createWidget({ | shadow | 是否显示阴影 | boolean| true,false| false| | isShadowShowingOnSelected| 选中状态下是否显示阴影|boolean| true,false | false| | trigger | 被选元素要触发的事件 | string | mousedown, mouseup, click, dblclick, lclick | null| -| handler | 点击事件回调 | function | | BI.emptyFn | +| handler | 点击事件回调 | function | —| BI.emptyFn | diff --git a/uidoc/case/combo/formula_combo.md b/uidoc/case/combo/formula_combo.md index ce4b888e2..3138d24ec 100644 --- a/uidoc/case/combo/formula_combo.md +++ b/uidoc/case/combo/formula_combo.md @@ -3,7 +3,7 @@ ## 基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/urvt04so/) +[source]() {% common %} ```javascript @@ -19,7 +19,7 @@ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | height | 高度 | number | —| 30 -| items | 子组件 | array | [ ]| +| items | 子组件 | array | — |[ ]| diff --git a/uidoc/case/combo/icon_combo.md b/uidoc/case/combo/icon_combo.md index 862beb896..0950b16e4 100644 --- a/uidoc/case/combo/icon_combo.md +++ b/uidoc/case/combo/icon_combo.md @@ -3,7 +3,7 @@ ## 基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/urvt04so/) +[source]() {% common %} ```javascript @@ -21,17 +21,17 @@ | :------ |:------------- | :-----| :----|:---- | width | 宽度 | number | — | 24 | height | 高度 | number | — | 24 -| iconClass | icon的类名 | string | " "| -| el | 开启弹出层的元素| object | { } | +| iconClass | icon的类名 | string | —|" "| +| el | 自定义下拉框trigger| object | —|{ } | | popup | 弹出层| object | —| { } | minWidth| 最小宽度| number | —|100| | maxWidth | 最大宽度 | string/number | — | "auto"| | maxHeight | 最大高度 | number | —| 300 -| adjustLength | 调整的距离 | number | — | 0 | +| adjustLength | 弹出列表和trigger的距离 | number | — | 0 | | adjustXOffset | 调整横向偏移 | number | — | 0 | | adjustYOffset |调整纵向偏移 | number | — | 0 | | offsetStyle | 弹出层显示位置 | string | left,right,center | "left,right,center"| -| chooseType | 选择类型 | const | | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | +| chooseType | 选择类型 | const | 参考button_group | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | diff --git a/uidoc/case/combo/static_combo.md b/uidoc/case/combo/static_combo.md index 517ead6c9..8d40ee827 100644 --- a/uidoc/case/combo/static_combo.md +++ b/uidoc/case/combo/static_combo.md @@ -3,7 +3,7 @@ ## 单选combo,基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/urvt04so/) +[source]() {% common %} ```javascript @@ -20,10 +20,10 @@ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | height | 高度 | number | — | 24 -| el | 开启弹出层的元素| object | { } | +| el | 自定义下拉框trigger| object | —|{ } | | items | 子组件 | array | — | [ ] | text | 文本内容 | string | — | " " | -| chooseType | 选择类型 | const | | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | +| chooseType | 选择类型 | const |参考button_group | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | diff --git a/uidoc/case/combo/text_value_downlist_combo.md b/uidoc/case/combo/text_value_downlist_combo.md index befedf12c..c575e783e 100644 --- a/uidoc/case/combo/text_value_downlist_combo.md +++ b/uidoc/case/combo/text_value_downlist_combo.md @@ -3,7 +3,7 @@ ## 基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/urvt04so/) +[source]() {% common %} ```javascript diff --git a/uidoc/case/editor/shelter_editor.md b/uidoc/case/editor/shelter_editor.md index f54bc1546..4b3fca830 100644 --- a/uidoc/case/editor/shelter_editor.md +++ b/uidoc/case/editor/shelter_editor.md @@ -27,19 +27,19 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | allowBlank | 是否允许空值 | boolean | true,false | true | -| watermark | 文本框placeholder | string | | " " | -| errorText | 错误提示 | string/function | | " "| +| watermark | 文本框placeholder | string | — | " " | +| errorText | 错误提示 | string/function | —| " "| | height| 高度| number |— | 30| -| textAlign| 对齐方式 | left,center,righta| | "left"| +| textAlign| 对齐方式 | string |left,center,right |"left"| diff --git a/uidoc/case/editor/sign_editor.md b/uidoc/case/editor/sign_editor.md index e033cf0bc..11dffc2e0 100644 --- a/uidoc/case/editor/sign_editor.md +++ b/uidoc/case/editor/sign_editor.md @@ -25,17 +25,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | —| 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | allowBlank | 是否允许空值 | boolean | true,false | true | -| watermark | 文本框placeholder | string | | " " | -| errorText | 错误提示 | string/function | | " "| +| watermark | 文本框placeholder | string | — | " " | +| errorText | 错误提示 | string/function | —| " "| | height| 高度| number |— | 30| diff --git a/uidoc/case/editor/sign_initial_editor.md b/uidoc/case/editor/sign_initial_editor.md index c7003ae0e..469fa443b 100644 --- a/uidoc/case/editor/sign_initial_editor.md +++ b/uidoc/case/editor/sign_initial_editor.md @@ -24,20 +24,20 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | —| 0 | | bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | allowBlank | 是否允许空值 | boolean | true,false | true | -| watermark | 文本框placeholder | string | | " " | -| errorText | 错误提示 | string/function | | " "| +| watermark | 文本框placeholder | string | — | " " | +| errorText | 错误提示 | string/function | —| " "| | height| 高度| number |— | 30| -| text | 文本内容 | string | | " " | -| value | 文本value值 | string | | " " | +| text | 文本内容 | string | —| " " | +| value | 文本value值 | string | — | " " | diff --git a/uidoc/case/editor/state_editor.md b/uidoc/case/editor/state_editor.md index 8c2cbc4e2..364a5cc0d 100644 --- a/uidoc/case/editor/state_editor.md +++ b/uidoc/case/editor/state_editor.md @@ -24,17 +24,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | —| 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function |— | — | | allowBlank | 是否允许空值 | boolean | true,false | true | -| watermark | 文本框placeholder | string | | " " | -| errorText | 错误提示 | string/function | | " "| +| watermark | 文本框placeholder | string | —| " " | +| errorText | 错误提示 | string/function |— | " "| | height| 高度| number |— | 30| diff --git a/uidoc/case/layer/pane_list.md b/uidoc/case/layer/pane_list.md index a501cabba..efb490f31 100644 --- a/uidoc/case/layer/pane_list.md +++ b/uidoc/case/layer/pane_list.md @@ -3,7 +3,7 @@ ## list面板，基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/p68bwkmv/) +[source]() {% common %} ```javascript @@ -24,12 +24,12 @@ | onLoad | 正在加载 | function | —| — | el | 开启panel的元素 | object | —|{type: "bi.button_group" }| | logic | | object |— | { dynamic:true} -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | —| 0 | +| lgap | 效果相当于容器left-padding值 | number | —| 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | diff --git a/uidoc/case/layer/panel.md b/uidoc/case/layer/panel.md index b8fc60be6..a4237b300 100644 --- a/uidoc/case/layer/panel.md +++ b/uidoc/case/layer/panel.md @@ -3,7 +3,7 @@ ## 带有标题栏的panel，基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/p68bwkmv/) +[source]() {% common %} ```javascript diff --git a/uidoc/core/abstract/button_group.md b/uidoc/core/abstract/button_group.md index ba630b45e..d79e75d18 100644 --- a/uidoc/core/abstract/button_group.md +++ b/uidoc/core/abstract/button_group.md @@ -30,17 +30,18 @@ BI.createWidget({ ## API ##### 基础属性 +###### chooseType可选值为 CHOOSE_TYPE_SINGLE,CHOOSE_TYPE_MULTI,CHOOSE_TYPE_ALL,CHOOSE_TYPE_NONE,CHOOSE_TYPE_DEFAULT | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| behaviors | |object | |{ }| -| items | 子组件数组 | array | | [ ] | -| chooseType | 选择类型 | const |CHOOSE_TYPE_SINGLE,CHOOSE_TYPE_MULTI,CHOOSE_TYPE_ALL,CHOOSE_TYPE_NONE,CHOOSE_TYPE_DEFAULT | CHOOSE_TYPE_SINGLE | -| layouts | 布局 | array | | [{type: "bi.center",hgap: 0,vgap: 0}] | +| behaviors | 自定义列表中item项的行为，如高亮，标红等 |object | — |{ }| +| items | 子组件数组 | array | — | [ ] | +| chooseType | 选择类型 | const | 见上| BI.ButtonGroup.CHOOSE_TYPE_SINGLE | +| layouts | 布局 | array | — | [{type: "bi.center",hgap: 0,vgap: 0}] | ## 对外方法 | 名称 | 说明 | 回调参数 | :------ |:------------- | :----- -| doBehavior | | —| +| doBehavior | 自定义列表中item项的行为，如高亮，标红等 | — | | prependItems | 内部前插入 | items | | addItems | 内部后插入 | items | | removeItemAt | 移除指定索引处的item | indexs | diff --git a/uidoc/core/abstract/collection_view.md b/uidoc/core/abstract/collection_view.md index bfcaeb4fa..a389e3ef3 100644 --- a/uidoc/core/abstract/collection_view.md +++ b/uidoc/core/abstract/collection_view.md @@ -34,14 +34,14 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| items | 子组件数组 | array | | [ ] | +| items | 子组件数组 | array | — | [ ] | | overflowX | 是否显示横向滚动条| boolean | true,false | true | | overflowY | 是否显示纵向滚动条 | boolean | true,false | true | -| cellSizeAndPositionGetter |设置每个单元格的位置坐标和宽高 | function| | — | -| horizontalOverscanSize | | number | | 0 | -| verticalOverscanSize | | number | | 0 | -| width | 行宽，必设 |number| | — | -| height | 列宽，必设 | number | | — | +| cellSizeAndPositionGetter |设置每个单元格的位置坐标和宽高 | function|— | — | +| horizontalOverscanSize | | number | — | 0 | +| verticalOverscanSize | | number | — | 0 | +| width | 行宽，必设 |number| —ßß | — | +| height | 列宽，必设 | number | —| — | | scrollLeft | 滚动条相对于左边的偏移 | number | — | 0 | | scrollTop | 滚动条相对于顶部的偏移 | number | — | 0 | diff --git a/uidoc/core/abstract/custom_tree.md b/uidoc/core/abstract/custom_tree.md index 903cd6f01..ccb5a5a7a 100644 --- a/uidoc/core/abstract/custom_tree.md +++ b/uidoc/core/abstract/custom_tree.md @@ -53,9 +53,9 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| items | 子组件数组 | array | | [ ] | -| itemsCreator| | | | | -| expander | | object | | {el: {},popup: {type: "bi.custom_tree"}}| +| items | 子组件数组 | array | — | [ ] | +| itemsCreator| 子组件构造器 | object | — | { } | +| expander | | object | | {el: {},popup: {type: "bi.custom_tree"}}| | el | | object | | {type: "bi.button_tree",chooseType: 0,layouts: [{type: "bi.vertical"}]}| @@ -68,7 +68,7 @@ BI.createWidget({ | prependItems | 内部前插入 | items | | addItems | 内部后插入 | items | | populate | 刷新列表 | nodes| -| render | 渲染列表 | | +| render | 渲染列表 | — | | setValue | 设置value值 | value,可以是单个值也可以是个数组 | | getValue | 获取被选中的值 |—| | getAllButtons | 获取所有button |—| diff --git a/uidoc/core/abstract/grid_view.md b/uidoc/core/abstract/grid_view.md index 367e117ed..833ef7a64 100644 --- a/uidoc/core/abstract/grid_view.md +++ b/uidoc/core/abstract/grid_view.md @@ -34,17 +34,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| items | 子组件数组 | array | | [ ] | +| items | 子组件数组 | array | — | [ ] | | overflowX | 是否显示横向滚动条| boolean | true,false | true | | overflowY | 是否显示纵向滚动条 | boolean | true,false | true | -| overscanColumnCount| | number| | 0 | -| overscanRowCount| | number | | 0 | -| width | 行宽，必设 |number| | — | -| height | 列宽，必设 | number | | — | -| rowHeightGetter| 每格行宽 |number,function | | function | -| columnWidthGetter| 每格列宽 | number,function | | function | -| estimatedColumnSize| 每格行宽，columnWidthGetter为function时必设 |number,function | | function | -| estimatedRowSize | 每格列宽，rowHeightGetter为function时必设 | number,function | | function | +| overscanColumnCount| | number|— | 0 | +| overscanRowCount| | number | — | 0 | +| width | 行宽，必设 |number| — | — | +| height | 列宽，必设 | number | —| — | +| rowHeightGetter| 每格行宽 |number,function | —| function | +| columnWidthGetter| 每格列宽 | number,function |— | function | +| estimatedColumnSize| 每格行宽，columnWidthGetter为function时必设 |number,function |— | function | +| estimatedRowSize | 每格列宽，rowHeightGetter为function时必设 | number,function | —| function | | scrollLeft | 滚动条相对于左边的偏移 | number | — | 0 | | scrollTop | 滚动条相对于顶部的偏移 | number | —|0 | @@ -72,6 +72,7 @@ BI.createWidget({ | :------ |:------------- |:----------| |BI.CollectionView.EVENT_SCROLL| 滚动时触发的事件 | {scrollLeft: scrollLeft, scrollTop: scrollTop} | + --- diff --git a/uidoc/core/abstract/virtual_group.md b/uidoc/core/abstract/virtual_group.md index 3d97ca641..9128c3733 100644 --- a/uidoc/core/abstract/virtual_group.md +++ b/uidoc/core/abstract/virtual_group.md @@ -29,8 +29,8 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| items | 子组件数组 | array | | [ ] | -| layouts | 布局 | array | | [{type: "bi.center",hgap: 0,vgap: 0}] | +| items | 子组件数组 | array | — | [ ] | +| layouts | 布局 | array | — | [{type: "bi.center",hgap: 0,vgap: 0}] | @@ -42,7 +42,7 @@ BI.createWidget({ | prependItems | 内部前插入 | items | | addItems | 内部后插入 | items | | populate | 刷新列表 | items | -| render | 渲染列表 | | +| render | 渲染列表 | —| diff --git a/uidoc/core/abstract/virtual_list.md b/uidoc/core/abstract/virtual_list.md index 5024b6e70..205483234 100644 --- a/uidoc/core/abstract/virtual_list.md +++ b/uidoc/core/abstract/virtual_list.md @@ -30,9 +30,9 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| items | 子组件数组 | array | | [ ] | -| blockSize | | number | | 10 | -| overscanHeight | | number | | 100 | +| items | 子组件数组 | array | — | [ ] | +| blockSize | | number | — | 10 | +| overscanHeight | | number | — | 100 | | scrollTop | 滚动条相对于顶部的偏移 | number | — | 0 | diff --git a/uidoc/core/basic_button.md b/uidoc/core/basic_button.md index cbd36279a..d30a82160 100644 --- a/uidoc/core/basic_button.md +++ b/uidoc/core/basic_button.md @@ -6,7 +6,7 @@ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| value | 组件value值 | string | | null| +| value | 组件value值 | string | —| null| | stopEvent | 阻止事件 |boolean | true,false | false | | stopPropagation | 阻止冒泡 | boolean | true,false| false | | selected | button的选中状态 | boolean | true,false |false | @@ -17,7 +17,7 @@ | shadow | 是否显示阴影 | boolean| true,false| false| | isShadowShowingOnSelected| 选中状态下是否显示阴影|boolean| true,false | false| | trigger | 被选元素要触发的事件 | string | mousedown, mouseup, click, dblclick, lclick | null| -| handler | 点击事件回调 | function | | BI.emptyFn | +| handler | 点击事件回调 | function | —| BI.emptyFn | ## 对外方法 diff --git a/uidoc/core/combination/bi.combo.md b/uidoc/core/combination/bi.combo.md index 6f3126e24..250ee1352 100644 --- a/uidoc/core/combination/bi.combo.md +++ b/uidoc/core/combination/bi.combo.md @@ -30,24 +30,24 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| trigger | 事件类型 | string | | "click" | +| el | 自定义下拉框trigger | object | — |{ }| +| trigger | 下拉列表的弹出方式 | string | click,hover | "click" | +| adjustLength | 弹出列表和trigger的距离 | number | — | 0 | | toggle | 切换状态 | boolean | true,false | true | -| direction | combo弹出层位置 | string | top,bottom,left,right,(top,left),(top,right),(bottom,left),(bottom,right) | "bottom"| +| direction | 弹出列表和trigger的位置关系 | string | top | bottom | left | right | top,left | top,right | bottom,left | bottom,right | "bottom"| | isDefaultInit | 是否默认初始化子节点 |boolean | true,false | false | | destroyWhenHide | 隐藏弹窗层是否销毁 | boolean | true,false | false | | isNeedAdjustHeight | 是否需要高度调整 | boolean | true,false | true | | isNeedAdjustWidth | 是否需要宽度调整 | boolean | true,false | true | | stopEvent | 是否阻止事件 | boolean | true,false | false | | stopPropagation | 阻止事件冒泡 | boolean | true,false | false | -| adjustLength | 调整的距离 | number | — | 0 | | adjustXOffset | 调整横向偏移 | number | — | 0 | | adjustYOffset |调整纵向偏移 | number | — | 0 | -| hideChecker | | function | | —| +| hideChecker | | function | — | —| | offsetStyle | 弹出层显示位置 | string | left,right,center | "left,right,center"| -| el | 开启弹出层的元素 | object | — |{ }| | popup | 弹出层 | object | — | { }| -| comboClass | | string | | "bi-combo-popup" | -| hoverClass | | string | | "bi-combo-hover" | +| comboClass | combo类 | string | — | "bi-combo-popup" | +| hoverClass | hover类 | string | — | "bi-combo-hover" | diff --git a/uidoc/core/combination/bi.expander.md b/uidoc/core/combination/bi.expander.md index fcad420df..5db37e917 100644 --- a/uidoc/core/combination/bi.expander.md +++ b/uidoc/core/combination/bi.expander.md @@ -7,14 +7,15 @@ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| trigger | 事件类型 | string | | "click" | +| el | 自定义下拉框trigger | object | — |{ }| +| trigger | 下拉列表的弹出方式 | string | click,hover | "click" | +| adjustLength | 弹出列表和trigger的距离 | number | — | 0 | | toggle | 切换状态 | boolean | true,false | true | -| direction | combo弹出层位置 | string | top,bottom,left,right,(top,left),(top,right),(bottom,left),(bottom,right) | "bottom"| +| direction | 弹出列表和trigger的位置关系 | string | top | bottom | left | right | top,left | top,right | bottom,left | bottom,right | "bottom"| | isDefaultInit | 是否默认初始化子节点 |boolean | true,false | false | -| el | 开启弹出层的元素 | object | — |{ }| | popup | 弹出层 | object | — | { }| -| expanderClass | | string | | "bi-expander-popup" | -| hoverClass | | string | | "bi-expander-hover" | +| expanderClass | 展开类 | string | —| "bi-expander-popup" | +| hoverClass | hover类| string | — | "bi-expander-hover" | @@ -25,13 +26,13 @@ | setValue | 设置combo value值| v | | getValue | 获取combo value值 | —| | isViewVisible | 弹窗层是否可见 | —| -| showView | || -| hideView ||| -| getView ||| +| showView | 显示弹出层| —| +| hideView | 隐藏弹出层| —| +| getView | 获取弹出层| —| | getAllLeaves | 获取所有的叶子节点 | —| | getNodeById | 根据id获取节点 | id | | getNodeByValue | 根据value值获取节点 | value | -| isExpanded | 节点是否展开 | | +| isExpanded | 节点是否展开 | — | | destroy | 销毁组件| — | ## 事件 diff --git a/uidoc/core/combination/group_combo.md b/uidoc/core/combination/group_combo.md index dc1998ab5..41c39d5eb 100644 --- a/uidoc/core/combination/group_combo.md +++ b/uidoc/core/combination/group_combo.md @@ -7,15 +7,15 @@ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| trigger | 事件类型 | string | | "click,hover" | -| direction | combo弹出层位置 | string | top,bottom,left,right,(top,left),(top,right),(bottom,left),(bottom,right) | "right"| | childern | 子组件 | array | — | [ ] | -| el | 开启弹出层的元素 | object | — | {type: "bi.text_button", text: "", value: ""}| | popup | 弹出层 | object | — |{el: {type: "bi.button_tree",chooseType: 0,layouts: [{type: "bi.vertical"}]}}| | isDefaultInit | 是否默认初始化子节点 |boolean | true,false | false | | isNeedAdjustHeight | 是否需要高度调整 | boolean | true,false | false | | isNeedAdjustWidth | 是否需要宽度调整 | boolean | true,false | false | -| adjustLength | 调整的距离 | number | — | 0 | +| el | 自定义下拉框trigger | object | — |{type: "bi.text_button", text: "", value: ""}| +| trigger | 下拉列表的弹出方式 | string | click,hover | "click" | +| adjustLength | 弹出列表和trigger的距离 | number | — | 0 | +| direction | 弹出列表和trigger的位置关系 | string | top | bottom | left | right | top,left | top,right | bottom,left | bottom,right | "bottom"| diff --git a/uidoc/core/combination/loader.md b/uidoc/core/combination/loader.md index acbd8a96e..41b6a444e 100644 --- a/uidoc/core/combination/loader.md +++ b/uidoc/core/combination/loader.md @@ -9,15 +9,15 @@ | :------ |:------------- | :-----| :----|:---- | direction | combo弹出层位置 | string | top,bottom,left,right,(top,left),(top,right),(bottom,left),(bottom,right) | "top"| | isDefaultInit | 是否默认初始化子数据 |boolean | true,false | true | -| logic | | object | | {dynamic:true,scrolly:true} | -| items| | array | | []| -| itemsCreator | | function | | — | -| onLoaded | | function | | — | +| logic | | object | —| {dynamic:true,scrolly:true} | +| items| 子组件 | array | — | []| +| itemsCreator | 子组件构造器 | function | — | — | +| onLoaded | 加载中 | function | — | — | | count | 是否显示总页数 | boolean| true,false|boolean| | prev | 上一页 | boolean | true,false | boolean | | next | 下一页 | boolean | true,false | boolean | -| hasPrev | 判断是否有上一页 | function | | — | -| hasNext | 判断是否有下一页 | function | | — | +| hasPrev | 判断是否有上一页 | function | — | — | +| hasNext | 判断是否有下一页 | function | — | — | diff --git a/uidoc/core/combination/navigation.md b/uidoc/core/combination/navigation.md index e0d64635a..11a5a7813 100644 --- a/uidoc/core/combination/navigation.md +++ b/uidoc/core/combination/navigation.md @@ -48,11 +48,10 @@ BI.createWidget({ | single | 是否为单页 | boolean | true,false | true | | defaultShowIndex | 是否默认显示 |boolean | true,false | true | | tab | tab页元素 | boolean | true,false | true | -| defaultShowIndex | 是否默认显示 | boolean | true,false | false | | logic | | object | | {dynamic:true} | | cardCreator | 面板构造器 | function | — | v | | afterCardCreated | 面板构造之后 | function | — | — | -| afterCardShow | 面板显示之后 | function | - | — | +| afterCardShow | 面板显示之后 | function | —| — | @@ -61,11 +60,11 @@ BI.createWidget({ | :------ |:------------- | :----- | render | 渲染组件 | — | | mounted | 挂载组件 | —| -| afterCardCreated | | v | -| afterCardShow | | v | +| afterCardCreated | 创建卡导航页页之后 | v | +| afterCardShow | 导航页展示之后 | v | | setSelect | 设置选中的index | v | | getSelect | 获取选中的index| —| -| getSelectedCard | | —| +| getSelectedCard | 获取选中的导航页| —| | populate | 刷新列表 | items | | setValue | 设置value值 | value | | getValue | 获取被选中的值 |—| diff --git a/uidoc/core/combination/searcher.md b/uidoc/core/combination/searcher.md index 04c522135..a7e26cb46 100644 --- a/uidoc/core/combination/searcher.md +++ b/uidoc/core/combination/searcher.md @@ -40,20 +40,20 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | +| hgap | 效果相当于容器左右padding值 | number | —| 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | —| 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | —| 0 | +| bgap | 效果相当于容器bottom-padding值 | number | —| 0 | | chooseType | 选择类型 | const | | CHOOSE_TYPE_SINGLE | | isDefaultInit | 是否默认初始化子节点 |boolean | true,false | false | | isAutoSearch | 是否自动搜索 |boolean | true,false | true | | isAutoSync | 是否自动同步数据, 即是否保持搜索面板和adapter面板状态值的统一 |boolean | true,false | true | -| onSearch | isAutoSearch为false时启用 | function(op.callback) | | | +| onSearch | isAutoSearch为false时启用 | function(op.callback) | — | —| | el | 开启弹出层的元素 | object | — | {type: "bi.search_editor"}| | popup | 弹出层 | object | — |{type: "bi.searcher_view"}| -| adapter | 弹出层显示的位置元素 | object | - | null| +| adapter | 弹出层显示的位置元素 | object | —| null| | masker | masker层 | object | — | {offset: {}}| ## 对外方法 @@ -64,7 +64,7 @@ BI.createWidget({ | getValue | 获取被选中的值 |—| | empty| 清空组件|—| | destroy| 销毁组件|—| -| adapter | | | +| adapter | 搜索列表位置 | — | | doSearch | 开始搜索 | — | | stopSearch | 停止搜索 | —| | isSearching | 是否正在搜索 | —| diff --git a/uidoc/core/combination/switcher.md b/uidoc/core/combination/switcher.md index 828ee5b7b..b7354fdf9 100644 --- a/uidoc/core/combination/switcher.md +++ b/uidoc/core/combination/switcher.md @@ -35,15 +35,15 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| trigger | 事件类型 | string | | "click" | +| trigger | 下拉列表的弹出方式 | string | click,hover | "click" | | toggle | 切换状态 | boolean | true,false | true | | direction | 面板显示的位置 | string | — | BI.Direction.Top | -| el | 开启弹出层的元素 | object | — | { }| +| el | 自定义下拉框trigger | object | — | { }| | popup | 弹出层 | object | — |{ }| | adapter | 弹出层的位置 | object | — | null| -| masker | masker层 | | — | { }| -| switcherClass | — | string| —| "bi-switcher-popup" | -| hoverClass | - | string | - | "bi-switcher-hover" | +| masker | masker层 | obejct | — | { }| +| switcherClass | 切换类 | string| —| "bi-switcher-popup" | +| hoverClass | hover类 | string | — | "bi-switcher-hover" | ## 对外方法 | 名称 | 说明 | 回调参数 diff --git a/uidoc/core/combination/tab.md b/uidoc/core/combination/tab.md index 5da59d153..ae3fad9e2 100644 --- a/uidoc/core/combination/tab.md +++ b/uidoc/core/combination/tab.md @@ -3,7 +3,7 @@ ## 切换显示或隐藏面板,[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/72gp1n0p/) +[source](https://jsfiddle.net/fineui/pdo5s8pq/) {% common %} ```javascript @@ -57,9 +57,8 @@ BI.createWidget({ | single | 是否为单页 | boolean | true,false | false | | defaultShowIndex | 是否默认显示tab页 | boolean | true,false | false | | tab | tab标签页 | object | — | { } | -| defaultShowIndex ||boolean | true,false | false | -| logic | | object | | {dynamic:false} | -| cardCreator | 面板构造器| function | | function (v) {return BI.createWidget();} | +| logic | | object | — | {dynamic:false} | +| cardCreator | 面板构造器| function | — | function (v) {return BI.createWidget();} | ## 对外方法 | 名称 | 说明 | 回调参数 diff --git a/uidoc/core/layer/layer_popup.md b/uidoc/core/layer/layer_popup.md index 8b4b39f49..70a43a7a1 100644 --- a/uidoc/core/layer/layer_popup.md +++ b/uidoc/core/layer/layer_popup.md @@ -40,17 +40,17 @@ BI.createWidget({ | minWidth | 弹出层最小宽度 | number | — | 100 | | maxHeight | 弹出层最大高度 | number/string | — | — | | minHeight | 弹出层最小高度 | number | — | 25 | -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | —| 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | —| 0 | +| tgap | 效果相当于容器top-padding值 | number | —| 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | | direction| 工具栏的方向| const | | BI.Direction.Top | | stopEvent | 是否停止mousedown、mouseup事件 | boolean | true,false | false | | stopPropagation | 是否停止mousedown、mouseup向上冒泡 | boolean | true,false | false | | tabs | 导航栏 | array | — | [] | -| logic | | object | | {dynamic:true} | +| logic | | object | — | {dynamic:true} | | tools | 自定义工具栏 |boolean | true,false | false | | buttons | toolbar栏 | array | — | [] | | el | 子组件 | object | — |{ type: "bi.button_group",items: [], chooseType: 0,behaviors: {},layouts: [{type: "bi.vertical"}]} | diff --git a/uidoc/core/layout/border.md b/uidoc/core/layout/border.md index 2030b1cd1..73ed1973a 100644 --- a/uidoc/core/layout/border.md +++ b/uidoc/core/layout/border.md @@ -49,6 +49,6 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| items | 子控件对象 | object | north,east,west,south,center | | | +| items | 子控件对象 | object | north,east,west,south,center | [ ] | --- \ No newline at end of file diff --git a/uidoc/core/layout/center.md b/uidoc/core/layout/center.md index de95464c9..be19b9e9d 100644 --- a/uidoc/core/layout/center.md +++ b/uidoc/core/layout/center.md @@ -44,12 +44,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | + --- \ No newline at end of file diff --git a/uidoc/core/layout/center_adapt.md b/uidoc/core/layout/center_adapt.md index c89b18475..25a58a328 100644 --- a/uidoc/core/layout/center_adapt.md +++ b/uidoc/core/layout/center_adapt.md @@ -36,13 +36,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| columnSize | 每列宽度所组成的数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| columnSize | 每列宽度所组成的数组 | array | — | [ ] | --- \ No newline at end of file diff --git a/uidoc/core/layout/float_center.md b/uidoc/core/layout/float_center.md index 1a32f1534..d65513fea 100644 --- a/uidoc/core/layout/float_center.md +++ b/uidoc/core/layout/float_center.md @@ -37,12 +37,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | + --- \ No newline at end of file diff --git a/uidoc/core/layout/flow.md b/uidoc/core/layout/flow.md index 1d90b2770..88f72ab03 100644 --- a/uidoc/core/layout/flow.md +++ b/uidoc/core/layout/flow.md @@ -62,13 +62,13 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | — | diff --git a/uidoc/core/layout/grid.md b/uidoc/core/layout/grid.md index ce5df9a9a..613e2aed8 100644 --- a/uidoc/core/layout/grid.md +++ b/uidoc/core/layout/grid.md @@ -1,6 +1,6 @@ # bi.grid -#### 上下的高度固定/左右的宽度固定，中间的高度/宽度自适应 +#### 网格布局 {% method %} [source](https://jsfiddle.net/fineui/1gwjbpL6/) @@ -62,9 +62,9 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| columns | 列的数量 | number | | null | -| rows | 行的数量 | number | | null | -| items | 子控件数组 | array | | [] | +| columns | 列数 | number | — | null | +| rows | 行数 | number | — | null | +| items | 子控件数组 | array | — | [] | diff --git a/uidoc/core/layout/horizontal.md b/uidoc/core/layout/horizontal.md index 59a3d510f..f0b3315c9 100644 --- a/uidoc/core/layout/horizontal.md +++ b/uidoc/core/layout/horizontal.md @@ -54,15 +54,14 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| columnSize | 每列宽度所组成的数组 | array | | | -| verticalAlign | 元素的垂直对齐方式 | string | | "middle" | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| columnSize | 每列宽度所组成的数组 | array | — | [ ] | +| verticalAlign | 元素的垂直对齐方式 | string | 参考相关css属性 | "middle" | | scrollx | 设置水平方向是否有滚动条 | boolean | true,false | true | --- \ No newline at end of file diff --git a/uidoc/core/layout/horizontal_adapt.md b/uidoc/core/layout/horizontal_adapt.md index c5d612436..33e41c616 100644 --- a/uidoc/core/layout/horizontal_adapt.md +++ b/uidoc/core/layout/horizontal_adapt.md @@ -38,16 +38,15 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| columnSize | 每列宽度所组成的数组 | array | | | -| verticalAlign | 元素的垂直对齐方式 | string | | "middle" | -| scrollx | 设置水平方向是否有滚动条 | boolean | true,false | true | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| columnSize | 每列宽度所组成的数组 | array | — | [ ] | +| verticalAlign | 元素的垂直对齐方式 | const | 参考相关css属性 | BI.VerticalAlign.Middle | + --- diff --git a/uidoc/core/layout/horizontal_auto.md b/uidoc/core/layout/horizontal_auto.md index 9572c92d0..91ee4f730 100644 --- a/uidoc/core/layout/horizontal_auto.md +++ b/uidoc/core/layout/horizontal_auto.md @@ -37,13 +37,13 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | + --- \ No newline at end of file diff --git a/uidoc/core/layout/horizontal_float.md b/uidoc/core/layout/horizontal_float.md index e681bcc61..2ec26e17c 100644 --- a/uidoc/core/layout/horizontal_float.md +++ b/uidoc/core/layout/horizontal_float.md @@ -1,4 +1,4 @@ -# horizontal_float +# bi.horizontal_float #### 浮动的水平居中布局 @@ -32,13 +32,13 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — |[ ] | --- \ No newline at end of file diff --git a/uidoc/core/layout/htape.md b/uidoc/core/layout/htape.md index 50d742e9c..166da0a9f 100644 --- a/uidoc/core/layout/htape.md +++ b/uidoc/core/layout/htape.md @@ -51,13 +51,13 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number |— | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | —| 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [{width: 100,el: {type: 'bi.button', text: 'button1'}},{width: 'fill',el: {type: 'bi.button', text: 'button2'}},{width: 200,el: {type: 'bi.button', text: 'button3'}}] | diff --git a/uidoc/core/layout/left_right_vertical_adapt.md b/uidoc/core/layout/left_right_vertical_adapt.md index 55099b067..8c101a587 100644 --- a/uidoc/core/layout/left_right_vertical_adapt.md +++ b/uidoc/core/layout/left_right_vertical_adapt.md @@ -10,7 +10,7 @@ ```javascript BI.createWidget({ - type: 'demo.left_right_vertical_adapt', + type: 'bi.left_right_vertical_adapt', element: "#wrapper", lhgap: 10, rhgap: 10, @@ -43,13 +43,13 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| lhgap | 左边容器左右padding值 | number | | 0 | -| lrgap | 左边容器right-padding值 | number | | 0 | -| llgap | 左边容器left-padding值 | number | | 0 | -| rhgap | 右边容器左右padding值 | number | | 0 | -| rrgap | 右边容器right-padding值 | number | | 0 | -| rhgap | 右边容器left-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| columnSize | 每列宽度所组成的数组 | array | | | | +| lhgap | 左边容器左右padding值 | number | — | 0 | +| lrgap | 左边容器right-padding值 | number | — | 0 | +| llgap | 左边容器left-padding值 | number | — | 0 | +| rhgap | 右边容器左右padding值 | number | — | 0 | +| rrgap | 右边容器right-padding值 | number | — | 0 | +| rhgap | 右边容器left-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | + --- \ No newline at end of file diff --git a/uidoc/core/layout/vertical.md b/uidoc/core/layout/vertical.md index 820c7c50d..a85b8b942 100644 --- a/uidoc/core/layout/vertical.md +++ b/uidoc/core/layout/vertical.md @@ -35,13 +35,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | | scrolly | 设置垂直方向是否有滚动条 | boolean | true,false | true | --- \ No newline at end of file diff --git a/uidoc/core/layout/vertical_adapt.md b/uidoc/core/layout/vertical_adapt.md index 3e12b4cfb..f3ea0a336 100644 --- a/uidoc/core/layout/vertical_adapt.md +++ b/uidoc/core/layout/vertical_adapt.md @@ -38,13 +38,12 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| columnSize | 每列宽度所组成的数组 | array | | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| columnSize | 每列宽度所组成的数组 | array | — | [ ] | --- \ No newline at end of file diff --git a/uidoc/core/layout/vtape.md b/uidoc/core/layout/vtape.md index cb83303be..370508b76 100644 --- a/uidoc/core/layout/vtape.md +++ b/uidoc/core/layout/vtape.md @@ -51,13 +51,13 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :----- | :----|:---- -| hgap | 效果相当于容器左右padding值 | number | | 0 | -| vgap | 效果相当于容器上下padding值 | number | | 0 | -| lgap | 效果相当于容器left-padding值 | number | | 0 | -| rgap | 效果相当于容器right-padding值 | number | | 0 | -| tgap | 效果相当于容器top-padding值 | number | | 0 | -| bgap | 效果相当于容器bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | +| hgap | 效果相当于容器左右padding值 | number | — | 0 | +| vgap | 效果相当于容器上下padding值 | number | — | 0 | +| lgap | 效果相当于容器left-padding值 | number | — | 0 | +| rgap | 效果相当于容器right-padding值 | number | — | 0 | +| tgap | 效果相当于容器top-padding值 | number | — | 0 | +| bgap | 效果相当于容器bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | {height: 100,el: {type: 'bi.button', text: 'button1'}},{height: 'fill',el: {type: 'bi.button', text: 'button2'}},{height: 200,el: {type: 'bi.button', text: 'button3'}} | diff --git a/uidoc/core/pane.md b/uidoc/core/pane.md index 9fa3f57cc..6c87f8f16 100644 --- a/uidoc/core/pane.md +++ b/uidoc/core/pane.md @@ -9,7 +9,7 @@ | :------ |:------------- | :-----| :----|:---- | tipText | title文本 | string | — | BI.i18nText("BI-No_Selected_Item") | | overlap| | boolean | true,false | true | -| onLoaded | | function | — | — | +| onLoaded | | function | — | — | ## 对外方法 diff --git a/uidoc/core/single.md b/uidoc/core/single.md index 296b9932b..a99f542b8 100644 --- a/uidoc/core/single.md +++ b/uidoc/core/single.md @@ -8,10 +8,10 @@ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- | readonly | 是否只读 | boolean | true,false| false | -| title | title | string | | null | -| warningTitle | 错误title | string | | null| +| title | title | string |— | null | +| warningTitle | 错误title | string | —| null| | tipType | title类型 | string | success,warning | null | -| value | 组件value值 | string | | null | +| value | 组件value值 | string |— | null | @@ -20,7 +20,7 @@ | :------ |:------------- | :----- | enableHover | 恢复hover可用| opt | | disabledHover | 取消hover事件 | —| -| populate | | —| +| populate | 刷新或者清空列表 | items | | setTitle | 设置title| title,opt | | setWarningTitle | 设置错误title | title,opt| | getTipType | 获取tipType|—| diff --git a/uidoc/core/widget.md b/uidoc/core/widget.md index 2c94965e3..18fae8ad1 100644 --- a/uidoc/core/widget.md +++ b/uidoc/core/widget.md @@ -6,16 +6,16 @@ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| root | | boolean | true,false | false | -| tagName | | string| | "div" | -| attributes | | | | null | -| data | | | | null | +| root | 根组件 | boolean | true,false | false | +| tagName | html标签 | string| —| "div" | +| attributes | 属性| object | —| null | +| data | 数据 | object | — | null | | disabled | 是否可用 | boolean |true,false | false | -| invisible | | boolean | true,false | false| +| invisible | 是否可见 | boolean | true,false | false| | invalid | 是否有效 | boolean | true,false |false | -| baseCls | 基础class类 | string | | " "| -| extraCls | 扩展class类 | string| | " "| -| cls | class类名 | string | | " "| +| baseCls | 基础class类 | string | —| " "| +| extraCls | 扩展class类 | string| — | " "| +| cls | class类名 | string |— | " "| ## 生命周期函数 | 名称 | 说明 | 回调参数 diff --git a/uidoc/detailed/bi.button/general.md b/uidoc/detailed/bi.button/general.md index 76159e264..76adf095c 100644 --- a/uidoc/detailed/bi.button/general.md +++ b/uidoc/detailed/bi.button/general.md @@ -3,6 +3,5 @@ ## 通用按钮,详情见[BI.button](/base/button/button.md) ---- diff --git a/uidoc/detailed/bi.button/items.md b/uidoc/detailed/bi.button/items.md index a73bd37d3..57bc8ae65 100644 --- a/uidoc/detailed/bi.button/items.md +++ b/uidoc/detailed/bi.button/items.md @@ -35,18 +35,18 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | ---- --- +--- diff --git a/uidoc/detailed/bi.button/node.md b/uidoc/detailed/bi.button/node.md index 74348d87b..1445723ba 100644 --- a/uidoc/detailed/bi.button/node.md +++ b/uidoc/detailed/bi.button/node.md @@ -42,17 +42,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | - - ---- --- +| hgap | 效果相当于文本框左右padding值，如果clear属性为true,该属性值置0 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | + + +--- diff --git a/uidoc/detailed/bi.button/segment.md b/uidoc/detailed/bi.button/segment.md index c70ee213d..2261e781e 100644 --- a/uidoc/detailed/bi.button/segment.md +++ b/uidoc/detailed/bi.button/segment.md @@ -42,17 +42,17 @@ BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | - - ---- --- +| hgap | 效果相当于文本框左右padding值 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | + + +--- diff --git a/uidoc/detailed/bi.button/tooltip.md b/uidoc/detailed/bi.button/tooltip.md index b3b6858f6..ad2075e88 100644 --- a/uidoc/detailed/bi.button/tooltip.md +++ b/uidoc/detailed/bi.button/tooltip.md @@ -29,17 +29,18 @@ var toast = BI.createWidget({ ##### 基础属性 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:---- -| hgap | 效果相当于文本框左右padding值 | number | | 10 | -| vgap | 效果相当于文本框上下padding值 | number | | 0 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| items | 子控件数组 | array | | | -| width | 宽度 | number | | | -| height | 高度 | number | | | - ------- ---- --- +| hgap | 效果相当于文本框左右padding值 | number | — | 10 | +| vgap | 效果相当于文本框上下padding值 | number | — | 0 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| items | 子控件数组 | array | — | [ ] | +| width | 宽度 | number | — | — | +| height | 高度 | number | — | — | + + + +--- diff --git a/uidoc/detailed/text_input/bi.clear_editor.md b/uidoc/detailed/text_input/bi.clear_editor.md index a13807abb..68aa3c1f7 100644 --- a/uidoc/detailed/text_input/bi.clear_editor.md +++ b/uidoc/detailed/text_input/bi.clear_editor.md @@ -22,30 +22,31 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 | function | — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | -| watermark | 文本框placeholder | string | | null | -| value | 文本框默认值 | string | | | -| errorText | 错误提示 | string | | null | -| width | 文本框宽度 | number | | | -| height | 文本框高度 | number | | 30 | +| watermark | 文本框placeholder | string | — | null | +| value | 文本框默认值 | string | — | " " | +| errorText | 错误提示 | string | — | null | +| width | 文本框宽度 | number | — | — | +| height | 文本框高度 | number | — | 30 | + ---- --- ## 事件 | 事件 | 说明 | | :------ |:------------- | |BI.ClearEditor.EVENT_CLEAR| 点击清空按钮触发 | ---- -其他事件详见[Input](../../base/editor/editor.md) +### 其他事件详见[Input](../../base/editor/editor.md) +--- + diff --git a/uidoc/detailed/text_input/bi.search_editor.md b/uidoc/detailed/text_input/bi.search_editor.md index d8ba9ea54..6d9ec5492 100644 --- a/uidoc/detailed/text_input/bi.search_editor.md +++ b/uidoc/detailed/text_input/bi.search_editor.md @@ -21,29 +21,31 @@ BI.createWidget({ | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | -| watermark | 文本框placeholder | string | | null | -| value | 文本框默认值 | string | | | -| errorText | 错误提示 | string | | null | -| width | 文本框宽度 | number | | | -| height | 文本框高度 | number | | 30 | +| watermark | 文本框placeholder | string | — | null | +| value | 文本框默认值 | string | — | " " | +| errorText | 错误提示 | string | —| null | +| width | 文本框宽度 | number | — | — | +| height | 文本框高度 | number | — | 30 | + ---- --- ## 事件 | 事件 | 说明 | | :------ |:------------- | |BI.SearchEditor.EVENT_CLEAR| 点击清空按钮触发 | ---- -其他事件详见[Editor](../../base/editor/editor.md) +### 其他事件详见[Editor](../../base/editor/editor.md) + + +--- diff --git a/uidoc/detailed/text_input/bi.text_editor.md b/uidoc/detailed/text_input/bi.text_editor.md index 507d733e4..b7e02ec3a 100644 --- a/uidoc/detailed/text_input/bi.text_editor.md +++ b/uidoc/detailed/text_input/bi.text_editor.md @@ -19,30 +19,31 @@ BI.createWidget({ {% endmethod %} -##API +## API | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| -| hgap | 效果相当于文本框左右padding值 | number | | 4 | -| vgap | 效果相当于文本框上下padding值 | number | | 2 | -| lgap | 效果相当于文本框left-padding值 | number | | 0 | -| rgap | 效果相当于文本框right-padding值 | number | | 0 | -| tgap |效果相当于文本框top-padding值 | number | | 0 | -| bgap | 效果相当于文本框bottom-padding值 | number | | 0 | -| validationChecker | 输入较验函数 |function| | | -| quitChecker | 是否允许退出编辑函数 | function | | | +| hgap | 效果相当于文本框左右padding值 | number | — | 4 | +| vgap | 效果相当于文本框上下padding值 | number | — | 2 | +| lgap | 效果相当于文本框left-padding值 | number | — | 0 | +| rgap | 效果相当于文本框right-padding值 | number | — | 0 | +| tgap |效果相当于文本框top-padding值 | number | — | 0 | +| bgap | 效果相当于文本框bottom-padding值 | number | — | 0 | +| validationChecker | 输入较验函数 |function| — | — | +| quitChecker | 是否允许退出编辑函数 | function | — | — | | mouseOut | | boolean | true,false | false | | allowBlank | 是否允许空值 | boolean | true,false | false | -| watermark | 文本框placeholder | string | | null | -| value | 文本框默认值 | string | | | -| errorText | 错误提示 | string | | null | -| width | 文本框宽度 | number | | | -| height | 文本框高度 | number | | 30 | - ---- --- - -## 事件 -| 事件 | 说明 | -| :------ |:------------- | ---- -其他事件详见[Editor](../../base/editor/editor.md) +| watermark | 文本框placeholder | string | — | null | +| value | 文本框默认值 | string | — | " " | +| errorText | 错误提示 | string | — | null | +| width | 文本框宽度 | number | — | — | +| height | 文本框高度 | number | — | 30 | + + + + +### 事件详见[Editor](../../base/editor/editor.md) + + + +--- \ No newline at end of file diff --git a/uidoc/detailed/text_input/finetuning_number_editor.md b/uidoc/detailed/text_input/finetuning_number_editor.md index 6e93db8b8..1864f9f73 100644 --- a/uidoc/detailed/text_input/finetuning_number_editor.md +++ b/uidoc/detailed/text_input/finetuning_number_editor.md @@ -16,14 +16,19 @@ BI.createWidget({ {% endmethod %} -##参数 +## 参数 | 参数 | 说明 | 类型 | 可选值 | 默认值 | :------ |:------------- | :-----| :----|:----| | value | 编辑框中的值，-1表示自动 | number | | -1 | ---- --- -##事件 + +## 事件 | 事件 | 说明 | -|BI.FineTuningNumberEditor.EVENT_CONFIRM| 点击增加/减少按钮或者编辑框确定时触发 | \ No newline at end of file +| :------ |:------------- | +|BI.FineTuningNumberEditor.EVENT_CONFIRM| 点击增加/减少按钮或者编辑框确定时触发 | + + + +--- \ No newline at end of file