BUI Fast 使用说明

目录

简介

BUI Fast 是BUI提供的快速书写代码提示插件，在Sublime,Atom,VSCode,APICloud Studio2 ,Webstorm中集成BUI控件及方法的代码提示，为快速开发助力. 里面封装了控件的常用参数及常用方法的语法补全, 版本对应 BUI的版本.

1.3.1版本新增 控件名加”-demo” 快速生成控件初始化及结构,只要把结构复制到body对应的位置就行.

重要: LinkIDE, Webstorm 这两个编辑器的代码不再更新. 推荐使用 vscode 编辑器.

安装

1. bui-fast 插件

下载解压以后,找到对应的编辑器插件

点击下载 BUI Fast 插件

在VScode安装 推荐

方法1: 在应用市场输入 bui-fast , 安装即可.

在HBuilderX的安装

1. 顶部菜单—工具—html代码块, 把下载解压的 BUI-Fast-Snippet-HbuilderX 目录的 bui-html-snippets.json 复制进去,保存;
2. 顶部菜单—工具—javascript代码块, 把下载解压的 BUI-Fast-Snippet-HbuilderX 目录的 bui-js-snippets.json 复制进去,保存;

在Sublimetext安装

Sublimetext 安装 BUI-Fast

• Windows: 打开顶部 Sublime Text 菜单 —> Preferences —> Browse Packages , 复制BUI-Fast-Snippet-SublimeText目录进去就好.

• Mac: 打开顶部 Sublime Text 菜单 —> Preferences —> Browse Packages ,复制BUI-Fast-Snippet-SublimeText目录进去就好

在Atom,APICloud安装

Atom ,APICloud Studio2 安装 BUI-Fast

使用快捷键 mac: command + shift + p , windows: ctrl + shift + p;

• 输入open your snippets, 回车; 打开下载的 bui-fast-snippet-atom/snippets.cson 文件, 复制内容到 snippets.cson 文件里面, 保存即可.

在Webstorm安装 (1.6.x 不再单独更新)

Webstorm 安装 BUI-Fast

方法1:

• 打开下载的 bui-fast-snippet-webstorm windows 目录, 复制 settings.jar 到桌面.

• 打开顶部菜单 File -> Import Settings, 找到刚刚的 settings.jar

• 重新启动webstorm 就可以了

方法2:

mac 的安装有可能会出现 import Settings 导入成功,但是无法使用的情况, 是因为webstorm的导入把templates导入在根目录了WebStorm2017.3/templates, 正确的目录应该是 WebStorm2017.3/settingsRepository/repository/templates.

复制 bui-fast-snippet-webstorm/templates 目录,替换 资源库/Preferences/WebStorm2017.3/settingsRepository/repository/templates

简单使用示例

?> 需要保存文件后缀为.html以后才能生效

ui-html 演示:

ui-page 演示:

bui-slide-demo 演示:

html触发结构代码片段的指令格式为: ‘ui-控件名’，之后点击Tab键即可进行补全 JS触发代码片段的指令格式为： ‘bui-控件名’，之后点击Tab键即可进行补全

注意: 生成代码后, 按Tab会定位在常用的编辑区域, 如果要写另外的控件代码, 要先按 Esc 再重复之前操作.

HTML 快速生成BUI控件结构

(在body里面书写) ui-accordion Tab ( 生成折叠菜单结构 )

<dl id="uiAccordion" class="bui-accordion">
  <dt class="bui-btn bui-box">
      <div class="span1"><!--折叠菜单--></div>
      <i class="icon-accordion"></i>
  </dt>
  <dd>
      <!--折叠菜单内容-->
  </dd>
</dl>

注意:如果忘记控件的名字, 输入 <ui- 会有提醒相关的控件 ( 生成的结构记得删掉第一个 < ).

JS 快速生成BUI控件初始化

(在script里面书写)

bui-accordion Tab

var uiAccordion = bui.accordion({
  id:"#uiAccordion"
});

JS 快速生成完整demo ( 推荐, 1.3.0 新增 )

(在script里面书写)

bui-list-demo Tab ( 生成list控件的初始化跟html结构 )

需要把html结构剪切到对应的位置去. 更多demo 请查看底部的控件列表

// 列表控件 js 初始化: 
var uiList = bui.list({
  id: "#uiList",
  url: "",
  data: {},             // 数据请求带过去的参数,分页在field配置
  template: listTemplate,
  field: {
      page: "page",     // 分页参数名
      size: "pageSize", // 分页大小参数名
      data: ""          // 数据字段名
  }
});
// 列表模板
function listTemplate (data) {
  var html = "";
  $.each(data,function(index, el) {
      html += '<li class="bui-btn" href="index.html"><i class="icon-facefill"></i>'+el.name+'</li>';
  });
  return html;
}
// 列表控件 html 对应的结构: 
<div id="uiList" class="bui-scroll">
  <div class="bui-scroll-head"></div>
  <div class="bui-scroll-main">
      <ul class="bui-list">
      </ul>
  </div>
  <div class="bui-scroll-foot"></div>
</div>

JS 快速生成BUI常用方法

(在script里面书写)

bui-ajax Tab ( 生成请求的方法 )

bui.ajax({
    url: "http://",
    data: {},//接口请求的参数
    // 可选参数
    method: "GET",
    timeout: 20000
}).done(function(result){
}).fail(function(result){
});

BUI JS方法及控件缩写

JS触发代码片段的指令格式为： ‘bui-控件名’，之后点击Tab键即可进行补全

控件简单初始化

控件名: bui.accordion 我们只需要输入 bui-accordion-demo Tab 就会生成完整的示例

控件完整demo缩写一览 (推荐 1.3.0新增)

控件名: bui.accordion 我们只需要输入 bui-accordion Tab 就会生成最简单的初始化脚本

BUI HTML结构缩写一览

html触发结构代码片段的指令格式为: ‘ui-控件名’，之后点击Tab键即可进行补全

控件结构缩写

页面结构缩写

布局结构缩写

表单元素结构缩写

新增结合数据驱动的标签, 1.6.x 从 b-text 改成 ui-b-text