diff --git a/uidoc/SUMMARY.md b/uidoc/SUMMARY.md index 18dc656884..9af941c034 100644 --- a/uidoc/SUMMARY.md +++ b/uidoc/SUMMARY.md @@ -103,7 +103,7 @@ * [formula_combo](case/combo/formula_combo.md) * [icon_combo](case/combo/icon_combo.md) * [static_combo](case/combo/static_combo.md) - * [text_value_combo](case/combo/static_combo.md) + * [text_value_combo](case/combo/text_value_combo.md) * [text_value_downlist_combo](case/combo/text_value_downlist_combo.md) * 树 * [branch_tree](case/tree/branch_tree.md) diff --git a/uidoc/case/button/multi_select_item.md b/uidoc/case/button/multi_select_item.md index 5242fd9c41..82856d6e43 100644 --- a/uidoc/case/button/multi_select_item.md +++ b/uidoc/case/button/multi_select_item.md @@ -1,2 +1,53 @@ -# multi_select_item +# bi.multi_select_item + +## 复选框item,基类[BI.BasicButton](/core/basic_button.md) + +{% method %} +[source](https://jsfiddle.net/fineui/0z1fud88/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.vertical', + element: "#wrapper", + items: [{ + type: "bi.label", + height: 30, + text: "复选item" + }, { + type: "bi.multi_select_item", + text: "复选项" + }] +}); + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | — | 30 +| logic | | object | | {dynamic:false} | + + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setSelected| 设置选中值| v | +| doRedMark | 标红 |—| +| unRedMark | 取消标红 | — | +| doClick | 点击事件| — + + + + + +--- + diff --git a/uidoc/case/button/single_select_item.md b/uidoc/case/button/single_select_item.md index abfc4264ca..811f07a266 100644 --- a/uidoc/case/button/single_select_item.md +++ b/uidoc/case/button/single_select_item.md @@ -1,2 +1,54 @@ -# single_select_item +# bi.single_select_item + +## 复选框item,基类[BI.BasicButton](/core/basic_button.md) + +{% method %} +[source](https://jsfiddle.net/fineui/19qqcej4/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.vertical', + element: "#wrapper", + items: [{ + type: "bi.label", + height: 30, + text: "复选item" + }, { + type: "bi.single_select_item", + text: "复选项" + }] +}); + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | — | 25 +| hgap | 效果相当于文本框左右padding值 |number | —| 10 | +|textAlign |文本对齐方式 |string |left,center,right |"left" + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setSelected| 设置选中值| v | +| doRedMark | 标红 |—| +| unRedMark | 取消标红 | — | +| doClick | 点击事件| — + + + + + + +--- + diff --git a/uidoc/case/button/single_select_radio_item.md b/uidoc/case/button/single_select_radio_item.md index f1c1aafc09..9aac21b3db 100644 --- a/uidoc/case/button/single_select_radio_item.md +++ b/uidoc/case/button/single_select_radio_item.md @@ -1,2 +1,55 @@ -# single_select_radio_item +# bi.single_select_radio_item + +## 单选框item,基类[BI.BasicButton](/core/basic_button.md) + +{% method %} +[source](https://jsfiddle.net/fineui/d3vw4438/) + +{% common %} +```javascript + +BI.createWidget({ + type: 'bi.vertical', + element: "#wrapper", + items: [{ + type: "bi.label", + height: 30, + text: "单选item" + }, { + type: "bi.single_select_radio_item", + text: "单选项" + }] +}); + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | — | 25 +| hgap | 效果相当于文本框左右padding值 |number | —| 10 | +|textAlign |文本对齐方式 |string |left,center,right |"left" + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setSelected| 设置选中值| v | +| doRedMark | 标红 |—| +| unRedMark | 取消标红 | — | +| doClick | 点击事件| — + + + + + + + +--- + diff --git a/uidoc/case/combo/bubble_combo.md b/uidoc/case/combo/bubble_combo.md index 98e00a5374..2a8bd56f10 100644 --- a/uidoc/case/combo/bubble_combo.md +++ b/uidoc/case/combo/bubble_combo.md @@ -1,2 +1,86 @@ -# bubble_combo +# bi.bubble_combo + +## 表示一个可以展开的节点, 不仅有选中状态而且有展开状态, 基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/urvt04so/) + +{% common %} +```javascript + +BI.createWidget({ + type: "bi.bubble_combo", + element:"#wrapper", + el: { + type: "bi.button", + text: "测试", + height: 25 + }, + popup: { + el: { + type: "bi.button_group", + items: BI.makeArray(100, { + type: "bi.text_item", + height: 25, + text: "item" + }), + layouts: [{ + type: "bi.vertical" + }] + }, + maxHeight: 200 + } + }) + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| text | | string | | "" | +| value | 组件value值 | string | |""| +| stopEvent | 阻止事件 |boolean | true,false | false | +| stopPropagation | 阻止冒泡 | boolean | true,false| false | +| selected | button的选中状态 | boolean | true,false |false | +| once | 点击一次选中有效,再点无效 | boolean | true,false | false| +| forceSelected | 点击即选中, 选中了就不会被取消,与once的区别是forceSelected不影响事件的触发| boolean | true,false| false| +| forceNotSelected | 无论怎么点击都不会被选中 | boolean| true,false | false| +| disableSelected | 使能选中| boolean | true,false| false| +| shadow | 是否显示阴影 | boolean| true,false| false| +| isShadowShowingOnSelected| 选中状态下是否显示阴影|boolean| true,false | false| +| trigger | 被选元素要触发的事件 | string | mousedown, mouseup, click, dblclick, lclick | null| +| handler | 点击事件回调 | function | | BI.emptyFn | + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| bindEvent | 绑定事件| —| +| beforeClick | 点击事件之前 | —| +| doClick | 点击事件 | — | +| handle | 返回该对象 | —| +| hover | hover事件| —| +| dishover | 取消hover事件| —| +|setSelected | 设置选中的文本| b| +| isSelected | 是否被选中| —| +| isOnce | 是否只允许点击一次| —| +| isForceSelected| 判断是否点击即选中| —| +| isForceNotSelected| 判断是否怎么点击都不会被选中|—| +| isDisableSelected| 判断是否让选中|—| +| setText| 设置文本值|—| +| getText| 获取文本值|—| +| empty| 清空组件|—| +| destroy| 销毁组件|—| + + + + + +--- + diff --git a/uidoc/case/combo/formula_combo.md b/uidoc/case/combo/formula_combo.md index 08154ed184..ce4b888e2d 100644 --- a/uidoc/case/combo/formula_combo.md +++ b/uidoc/case/combo/formula_combo.md @@ -1,2 +1,38 @@ -# formula_combo +# bi.formula_combo_trigger + +## 基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/urvt04so/) + +{% common %} +```javascript + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | —| 30 +| items | 子组件 | array | [ ]| + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setValue| 设置value值|—| +| getValue| 获取value值|—| + + + + + +--- + diff --git a/uidoc/case/combo/icon_combo.md b/uidoc/case/combo/icon_combo.md index 327bcce006..862beb8967 100644 --- a/uidoc/case/combo/icon_combo.md +++ b/uidoc/case/combo/icon_combo.md @@ -1,2 +1,53 @@ -# icon_combo +# bi.icon_combo + +## 基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/urvt04so/) + +{% common %} +```javascript + + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| width | 宽度 | number | — | 24 +| height | 高度 | number | — | 24 +| iconClass | icon的类名 | string | " "| +| el | 开启弹出层的元素| object | { } | +| popup | 弹出层| object | —| { } +| minWidth| 最小宽度| number | —|100| +| maxWidth | 最大宽度 | string/number | — | "auto"| +| maxHeight | 最大高度 | number | —| 300 +| adjustLength | 调整的距离 | number | — | 0 | +| adjustXOffset | 调整横向偏移 | number | — | 0 | +| adjustYOffset |调整纵向偏移 | number | — | 0 | +| offsetStyle | 弹出层显示位置 | string | left,right,center | "left,right,center"| +| chooseType | 选择类型 | const | | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setValue| 设置value值|—| +| getValue| 获取value值|—| +| showView | 显示弹出层 | —| +| hideView | 隐藏弹出层 |—| +| populate | 刷新列表 | items | + + + + + +--- + diff --git a/uidoc/case/combo/static_combo.md b/uidoc/case/combo/static_combo.md index cc344aea14..517ead6c99 100644 --- a/uidoc/case/combo/static_combo.md +++ b/uidoc/case/combo/static_combo.md @@ -1,2 +1,43 @@ -# static_combo +# bi.static_combo + +## 单选combo,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/urvt04so/) + +{% common %} +```javascript + + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | — | 24 +| el | 开启弹出层的元素| object | { } | +| items | 子组件 | array | — | [ ] +| text | 文本内容 | string | — | " " | +| chooseType | 选择类型 | const | | BI.ButtonGroup.CHOOSE_TYPE_SINGLE | + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setValue| 设置value值|—| +| getValue| 获取value值|—| +| populate | 刷新列表 | items | + + + + + +--- + diff --git a/uidoc/case/combo/text_value_downlist_combo.md b/uidoc/case/combo/text_value_downlist_combo.md index 22b630fbdf..befedf12c4 100644 --- a/uidoc/case/combo/text_value_downlist_combo.md +++ b/uidoc/case/combo/text_value_downlist_combo.md @@ -1,2 +1,40 @@ -# text_value_downlist_combo +# bi.text_value_down_list_combo + +## 基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/urvt04so/) + +{% common %} +```javascript + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| height | 高度 | number | — | 30 +| text | 文本内容 | string | — | " " | + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setValue| 设置value值|—| +| getValue| 获取value值|—| +| populate | 刷新列表 | items | + + + + + +--- + diff --git a/uidoc/case/editor/shelter_editor.md b/uidoc/case/editor/shelter_editor.md index fad4df025e..f54bc15463 100644 --- a/uidoc/case/editor/shelter_editor.md +++ b/uidoc/case/editor/shelter_editor.md @@ -1,2 +1,96 @@ -# shelter_editor +# bi.shelter_editor + +## 带标记的文本框,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/9Lbx6kga/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.shelter_editor", + cls: "bi-border", + ref:function(_ref){ + editor=_ref; + }, + width: 300, + watermark: "这个是带标记的" +}); + +``` + +{% endmethod %} + +## 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 | | | +| allowBlank | 是否允许空值 | boolean | true,false | true | +| watermark | 文本框placeholder | string | | " " | +| errorText | 错误提示 | string/function | | " "| +| height| 高度| number |— | 30| +| textAlign| 对齐方式 | left,center,righta| | "left"| + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setErrorText | 设置错误文本 | text | +| getErrorText | 获取错误文本 | —| +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| onKeyDown |按键事件|key| +| setValue | 设置文本框值|value| +| getLastValidValue | 获取文本框最后一次输入的有效值| —| +| setTextStyle| 设置文本框样式| style | +| getValue | 获取文本框值|—| +| isEditing | 文本框是否处于编辑状态|—| +| isValid | 文本框值是否有效|—| +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setTitle| 设置title | title| +| setWarningTitle| 设置错误title | title | +| setState | 设置文本框值 |— +| getState | 获取文本框值 | — + +## 事件 +| 事件 | 说明 | +| :------ |:------------- | +|BI.Editor.EVENT_CHANGE | editor的value发生改变触发 | +|BI.Editor.EVENT_FOCUS | focus事件 | +|BI.Editor.EVENT_BLUR | blur事件 | +|BI.Editor.EVENT_CLICK | 点击编辑框触发(不在编辑状态时) | +|BI.Editor.EVENT_KEY_DOWN | keyDown时触发 | +|BI.Editor.EVENT_SPACE | 按下空格触发 | +|BI.Editor.EVENT_BACKSPACE | 按下Backspace触发 | +|BI.Editor.EVENT_START | 开始输入触发 | +|BI.Editor.EVENT_PAUSE | 暂停输入触发(输入空白字符) | +|BI.Editor.EVENT_STOP | 停止输入触发 | +|BI.Editor.EVENT_CONFIRM | 确定输入触发（blur时且输入值有效） | +|BI.Editor.EVENT_VALID | 输入值有效的状态事件 | +|BI.Editor.EVENT_ERROR | 输入值无效的状态事件 | +|BI.Editor.EVENT_ENTER | 回车事件 | +|BI.Editor.EVENT_RESTRICT | 回车但是值不合法 | +|BI.Editor.EVENT_REMOVE | 输入为空时按下backspace | +|BI.Editor.EVENT_EMPTY | 输入框为空时触发 | + + + + +--- + diff --git a/uidoc/case/editor/sign_editor.md b/uidoc/case/editor/sign_editor.md index 8b11168759..e033cf0bcc 100644 --- a/uidoc/case/editor/sign_editor.md +++ b/uidoc/case/editor/sign_editor.md @@ -1,2 +1,91 @@ -# sign_editor +# bi.sign_editor + +## 带标记的文本框,基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/tmdedu5t/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.sign_editor", + cls:"layout-bg5", + value: "123", + text: "456", + width: 300 +}); + +``` + +{% endmethod %} + +## 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 | | | +| allowBlank | 是否允许空值 | boolean | true,false | true | +| watermark | 文本框placeholder | string | | " " | +| errorText | 错误提示 | string/function | | " "| +| height| 高度| number |— | 30| + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setErrorText | 设置错误文本 | text | +| getErrorText | 获取错误文本 | —| +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| setValue | 设置文本框值|value| +| getLastValidValue | 获取文本框最后一次输入的有效值| —| +| getValue | 获取文本框值|—| +| isEditing | 文本框是否处于编辑状态|—| +| isValid | 文本框值是否有效|—| +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setTitle| 设置title | title| +| setWarningTitle| 设置错误title | title | +| setState | 设置文本框值 |— +| getState | 获取文本框值 | — + +## 事件 +| 事件 | 说明 | +| :------ |:------------- | +|BI.Editor.EVENT_CHANGE | editor的value发生改变触发 | +|BI.Editor.EVENT_FOCUS | focus事件 | +|BI.Editor.EVENT_BLUR | blur事件 | +|BI.Editor.EVENT_CLICK | 点击编辑框触发(不在编辑状态时) | +|BI.Editor.EVENT_KEY_DOWN | keyDown时触发 | +|BI.Editor.EVENT_SPACE | 按下空格触发 | +|BI.Editor.EVENT_BACKSPACE | 按下Backspace触发 | +|BI.Editor.EVENT_START | 开始输入触发 | +|BI.Editor.EVENT_PAUSE | 暂停输入触发(输入空白字符) | +|BI.Editor.EVENT_STOP | 停止输入触发 | +|BI.Editor.EVENT_CONFIRM | 确定输入触发（blur时且输入值有效） | +|BI.Editor.EVENT_VALID | 输入值有效的状态事件 | +|BI.Editor.EVENT_ERROR | 输入值无效的状态事件 | +|BI.Editor.EVENT_ENTER | 回车事件 | +|BI.Editor.EVENT_RESTRICT | 回车但是值不合法 | +|BI.Editor.EVENT_REMOVE | 输入为空时按下backspace | +|BI.Editor.EVENT_EMPTY | 输入框为空时触发 | + + + + +--- + diff --git a/uidoc/case/editor/sign_initial_editor.md b/uidoc/case/editor/sign_initial_editor.md index 68f85722da..c7003ae0e3 100644 --- a/uidoc/case/editor/sign_initial_editor.md +++ b/uidoc/case/editor/sign_initial_editor.md @@ -1,2 +1,92 @@ -# sign_initial_editor +# bi.sign_initial_editor + +## 基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/9vjghevp/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.sign_initial_editor", + cls: "layout-bg5", + text: "原始值", + width: 300 +}); + +``` + +{% endmethod %} + +## 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 | | | +| allowBlank | 是否允许空值 | boolean | true,false | true | +| watermark | 文本框placeholder | string | | " " | +| errorText | 错误提示 | string/function | | " "| +| height| 高度| number |— | 30| +| text | 文本内容 | string | | " " | +| value | 文本value值 | string | | " " | + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setErrorText | 设置错误文本 | text | +| getErrorText | 获取错误文本 | —| +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| setValue | 设置文本框值|value| +| getLastValidValue | 获取文本框最后一次输入的有效值| —| +| getValue | 获取文本框值|—| +| isEditing | 文本框是否处于编辑状态|—| +| isValid | 文本框值是否有效|—| +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setTitle| 设置title | title| +| setWarningTitle| 设置错误title | title | +| setState | 设置文本框值 |— +| getState | 获取文本框值 | — + +## 事件 +| 事件 | 说明 | +| :------ |:------------- | +|BI.Editor.EVENT_CHANGE | editor的value发生改变触发 | +|BI.Editor.EVENT_FOCUS | focus事件 | +|BI.Editor.EVENT_BLUR | blur事件 | +|BI.Editor.EVENT_CLICK | 点击编辑框触发(不在编辑状态时) | +|BI.Editor.EVENT_KEY_DOWN | keyDown时触发 | +|BI.Editor.EVENT_SPACE | 按下空格触发 | +|BI.Editor.EVENT_BACKSPACE | 按下Backspace触发 | +|BI.Editor.EVENT_START | 开始输入触发 | +|BI.Editor.EVENT_PAUSE | 暂停输入触发(输入空白字符) | +|BI.Editor.EVENT_STOP | 停止输入触发 | +|BI.Editor.EVENT_CONFIRM | 确定输入触发（blur时且输入值有效） | +|BI.Editor.EVENT_VALID | 输入值有效的状态事件 | +|BI.Editor.EVENT_ERROR | 输入值无效的状态事件 | +|BI.Editor.EVENT_ENTER | 回车事件 | +|BI.Editor.EVENT_RESTRICT | 回车但是值不合法 | +|BI.Editor.EVENT_REMOVE | 输入为空时按下backspace | +|BI.Editor.EVENT_EMPTY | 输入框为空时触发 | + + + + +--- + diff --git a/uidoc/case/editor/state_editor.md b/uidoc/case/editor/state_editor.md index 66d479a654..8c2cbc4e20 100644 --- a/uidoc/case/editor/state_editor.md +++ b/uidoc/case/editor/state_editor.md @@ -1,2 +1,89 @@ -# state_editor +# bi.state_editor + +## 记录状态的输入框，基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/p68bwkmv/) + +{% common %} +```javascript + +BI.createWidget({ + element: "#wrapper", + type: "bi.state_editor", + value: "123", + text: "456", + width: 300 +}); + +``` + +{% endmethod %} + +## 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 | | | +| allowBlank | 是否允许空值 | boolean | true,false | true | +| watermark | 文本框placeholder | string | | " " | +| errorText | 错误提示 | string/function | | " "| +| height| 高度| number |— | 30| + + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setErrorText | 设置错误文本 | text | +| getErrorText | 获取错误文本 | —| +| focus | 文本框获取焦点| — | +| blur | 文本框失焦|—| +| setValue | 设置文本框值|value| +| getLastValidValue | 获取文本框最后一次输入的有效值| —| +| getValue | 获取文本框值|—| +| isEditing | 文本框是否处于编辑状态|—| +| isValid | 文本框值是否有效|—| +| doRedMark | 文本标红 | — | +| unRedMark | 取消文本标红| —| +| doHighLight | 文本高亮 | —| +| unHighLight | 取消文本高亮 | —| +| setState | 设置文本框值 |— +| getState | 获取文本框值 | — + +## 事件 +| 事件 | 说明 | +| :------ |:------------- | +|BI.Editor.EVENT_CHANGE | editor的value发生改变触发 | +|BI.Editor.EVENT_FOCUS | focus事件 | +|BI.Editor.EVENT_BLUR | blur事件 | +|BI.Editor.EVENT_CLICK | 点击编辑框触发(不在编辑状态时) | +|BI.Editor.EVENT_KEY_DOWN | keyDown时触发 | +|BI.Editor.EVENT_SPACE | 按下空格触发 | +|BI.Editor.EVENT_BACKSPACE | 按下Backspace触发 | +|BI.Editor.EVENT_START | 开始输入触发 | +|BI.Editor.EVENT_PAUSE | 暂停输入触发(输入空白字符) | +|BI.Editor.EVENT_STOP | 停止输入触发 | +|BI.Editor.EVENT_CONFIRM | 确定输入触发（blur时且输入值有效） | +|BI.Editor.EVENT_VALID | 输入值有效的状态事件 | +|BI.Editor.EVENT_ERROR | 输入值无效的状态事件 | +|BI.Editor.EVENT_ENTER | 回车事件 | +|BI.Editor.EVENT_RESTRICT | 回车但是值不合法 | +|BI.Editor.EVENT_REMOVE | 输入为空时按下backspace | +|BI.Editor.EVENT_EMPTY | 输入框为空时触发 | + + + + +--- + diff --git a/uidoc/case/layer/pane_list.md b/uidoc/case/layer/pane_list.md index af8d225eff..a501cabbad 100644 --- a/uidoc/case/layer/pane_list.md +++ b/uidoc/case/layer/pane_list.md @@ -1,2 +1,68 @@ -# pane_list +# bi.list_pane + +## list面板，基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/p68bwkmv/) + +{% common %} +```javascript + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| items | 列表 | array | — | [ ] +| itemsCreator | 列表创建器| function | — | — +| hasNext | 是否有下一页 | function | —| — +| 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 | + + + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| prependItems | 内部前插入 | items | +| addItems | 内部后插入 | items | +| removeItemAt | 移除指定索引处的item | indexs | +| populate | 刷新列表 | items | +| setNotSelectedValue| 设置未被选中的值 | value,可以是单个值也可以是个数组| +| setValue | 设置value值 | value,可以是单个值也可以是个数组 | +| getNotSelectedValue | 获取没有被选中的值 | —| +| getValue | 获取被选中的值 |—| +| getAllButtons | 获取所有button |—| +| getAllLeaves | 获取所有的叶子节点 | —| +| getSelectedButtons | 获取所有被选中的元素 | —| +| getNotSelectedButtons | 获取所有未被选中的元素 | —| +| getIndexByValue | 根据value值获取value在数组中的索引 | value| +| getNodeById | 根据id获取节点 | id | +| getNodeByValue | 根据value值获取节点 | value | +| empty| 清空组件|—| +| hasPrev| 是否有上一页|—| +| hasNext | 是否有下一页 | — + + + + + + +--- + diff --git a/uidoc/case/layer/panel.md b/uidoc/case/layer/panel.md index f267546029..b8fc60be6e 100644 --- a/uidoc/case/layer/panel.md +++ b/uidoc/case/layer/panel.md @@ -1,2 +1,40 @@ -# panel +# bi.panel + +## 带有标题栏的panel，基类[BI.Widget](/core/widget.md) + +{% method %} +[source](https://jsfiddle.net/fineui/p68bwkmv/) + +{% common %} +```javascript + + + +``` + +{% endmethod %} + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| title | 标题 | string | — | " " +| titleButton | | array | —| [ ] +| el | 开启panel的元素 | object | —|{ }| +| logic | | object |— | { dynamic:false} + + + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| setTitle |设置标题| title + + + + + +--- + diff --git a/uidoc/core/combination/bi.combo.md b/uidoc/core/combination/bi.combo.md index cea51dabce..6f3126e242 100644 --- a/uidoc/core/combination/bi.combo.md +++ b/uidoc/core/combination/bi.combo.md @@ -37,7 +37,7 @@ BI.createWidget({ | destroyWhenHide | 隐藏弹窗层是否销毁 | boolean | true,false | false | | isNeedAdjustHeight | 是否需要高度调整 | boolean | true,false | true | | isNeedAdjustWidth | 是否需要宽度调整 | boolean | true,false | true | -| stopEvent | 阻止事件冒泡 | boolean | true,false | false | +| stopEvent | 是否阻止事件 | boolean | true,false | false | | stopPropagation | 阻止事件冒泡 | boolean | true,false | false | | adjustLength | 调整的距离 | number | — | 0 | | adjustXOffset | 调整横向偏移 | number | — | 0 | @@ -62,12 +62,12 @@ BI.createWidget({ | setValue |设置combo value值| v | | getValue | 获取combo value值 | —| | isViewVisible | 弹窗层是否可见 | —| -| showView | || -| hideView ||| -| getView ||| -| getPopupPosition ||| -| toggle ||| -|destroy ||| +| showView | 显示弹出层 | —| +| hideView | 隐藏弹出层 |—| +| getView | 获取弹出层 | —| +| getPopupPosition | 获取弹出层的位置 | —| +| toggle | 开启或者隐藏弹出层 | —| +| destroy | 销毁组件 | —| ## 事件 | 名称 | 说明 | @@ -81,6 +81,8 @@ BI.createWidget({ |BI.Combo.EVENT_AFTER_POPUPVIEW | 下拉列表弹出后触发 | |BI.Combo.EVENT_BEFORE_HIDEVIEW | 下拉列表收起前触发 | |BI.Combo.EVENT_AFTER_HIDEVIEW | 下拉列表收起后触发 | + + --- diff --git a/uidoc/core/layer/layer_popup.md b/uidoc/core/layer/layer_popup.md index 9c8659ec4d..8b4b39f491 100644 --- a/uidoc/core/layer/layer_popup.md +++ b/uidoc/core/layer/layer_popup.md @@ -64,7 +64,7 @@ BI.createWidget({ | resetHeight | 重置高度 | height| | setValue | 设置value 值 | value | | getValue| 获取value值 | —| -| setZindex | 设置z-inex| z-index | +| setZindex | 设置z-index| z-index | | getView | 获取弹出层 | —| diff --git a/uidoc/core/layer/layer_searcher.md b/uidoc/core/layer/layer_searcher.md index 168f94c922..4eb4c00d2f 100644 --- a/uidoc/core/layer/layer_searcher.md +++ b/uidoc/core/layer/layer_searcher.md @@ -1,13 +1,27 @@ # bi.searcher_view -## 搜索面板, [BI.Widget](/core/widget.md) +## 搜索面板, 基类[BI.Widget](/core/widget.md) {% method %} -[source](https://jsfiddle.net/fineui/k6s24et1/) +[source](https://jsfiddle.net/fineui/qkfns6wm/) {% common %} ```javascript +var searcher = BI.createWidget({ + element: "#wrapper", + type: "bi.searcher_view", +}); +searcher.populate([{ + text: "aba", + value: "aba" +},{ + text: "acc", + value: "acc" +}], [{ + text: "a", + value: "a" +}], "a"); diff --git a/uidoc/core/node_button.md b/uidoc/core/node_button.md index 3f4233970e..212f98fda5 100644 --- a/uidoc/core/node_button.md +++ b/uidoc/core/node_button.md @@ -1,2 +1,28 @@ -# node_button +# bi.NodeButton + +## 表示一个可以展开的节点, 不仅有选中状态而且有展开状态, [BI.BasicButton](/core/basic_button.md) + + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| open | 节点是否展开 | boolean | true,false | false | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| doClick | 点击展开| — +| isOnce | 点击一次后失效 | — +| isOpened | 判断节点是否展开| — +| setOpened | 设置节点展开状态| b +| triggerCollapse | 节点收起 | — +| triggerExpand | 节点展开| — + + + + +--- + diff --git a/uidoc/core/pane.md b/uidoc/core/pane.md index d2d2429a03..9fa3f57cc7 100644 --- a/uidoc/core/pane.md +++ b/uidoc/core/pane.md @@ -1,2 +1,32 @@ -# pane +# bi.pane + +## 当没有元素时有提示信息的view, [BI.Widget](/core/widget.md) + + +## API +##### 基础属性 +| 参数 | 说明 | 类型 | 可选值 | 默认值 +| :------ |:------------- | :-----| :----|:---- +| tipText | title文本 | string | — | BI.i18nText("BI-No_Selected_Item") | +| overlap| | boolean | true,false | true | +| onLoaded | | function | — | — | + + +## 对外方法 +| 名称 | 说明 | 回调参数 +| :------ |:------------- | :----- +| populate | 刷新列表 | items | +| empty | 清空组件 | — | +| hasMatched | 是否有匹配的元素 | —| +| loading | 加载中 | — | +| loaded | 加载完毕 | — +| check | 检查是否为空| — +| setTipVisible | 设tip可见| — + + + + + +--- +