cola-ui的使用

alterem發表於2019-07-18
UI

我們一起看看如何優雅的使用cola-ui

官網：http://www.cola-ui.com

教程位置：http://www.cola-ui.com/guide/model

API: http://www.cola-ui.com/api/cola.html , http://legacy.cola-ui.com

元件地址：http://www.cola-ui.com/docs/button

原始碼地址：https://github.com/Cola-Org/cola-ui

產品簡介

  • Cola UI是支援雙向資料繫結的一站式前端UI框架。採用了精簡的MVVM架構，在確保靈活性的同時儘可能降低對開發者的技術要求。
  • Cola UI遵循Mobile First的策略，特別適合於移動裝置應用開發。
  • Cola UI整合了jQuery和Semantic UI，同時提供更多常用的List、Table、Tree等高階控制元件。

開始

以上內容都是通過cola-ui官網獲得的資料，絕大多數的開發內容可以參考cola-ui官網提供的API進行查閱

本文件主要針對於camsi工程中用到的功能或特性，且可能不存在於cola-ui官網提供的API進行整理和說明

組成結構

通常要基於camsi工程在瀏覽器渲染出來的頁面由三個部分組成，例如：simple01.jade、M.js、simple01Model.js

Jade

Jade 是一個高效能的模板引擎，它深受 Haml影響，它是用 JavaScript 實現的，並且可以供 [Node](http://nodejs.org/) 使用，你也可以[在此試用](http://naltatis.github.io/jade-syntax-docs/)，這裡推薦[Jade入門中文文件](http://www.nooong.com/docs/jade_chinese.htm)

extends /_page
block body
    v-box
        flex-box
            .content(style="overflow: auto")
                c-table(bind="simple01s" dataType="Simple01")
                    column(property="name")
append scripts
    script(src="simple01Model.js")
    script(src="simple01.js")

dataType的值應該與Js中定義的dataType的值以及Model.js中定義的dataType的值相等

Js

不做描述

cola(function(model) {
    model.dataType($DataType.Simple01);
    model.describe("simple01s", {
        dataType : "Simple01",
        provider : {
            url : "controller/simple01Service/findPagination?from={{$from}}&limit={{$limit}}",
            pageSize : 10,
            sendJson : true,
            loadMode: 'manual'
        }
    });
    model.set("title", "[(#{simple01})]");
    model.action({
        test : function() {
            cola.alert('test')
        }
    });
});

所有正規的操作包括事件都應該編寫在cola(function(model) { })中，其中首先需要使用dataType定義當前Js中所有用到的DataType，使用model.describe互動後臺資料到當前指定model，使用model.set("", "")向model互動資料，頁面所有用到的事件方法應該存在於model.action({})中。

Model.js

由cola-ui定義的前端模型

var $DataType = {
        Simple01: {
        name: "Simple01",
        properties : {
            name : {
                caption : "[(#{name})]",
                dataType : "string"
            }
        }
    }
};

caption用來標誌當前欄位的前端顯示文字，使用[(#{ })]取到當前欄位對應的當前語言的國際化翻譯。

表單相關

表單對國際化的處理

在正常情況下，dataType可能會被公用，然後每個欄位在每個不同的地方顯示的文字標識不一樣，這時候可以使用caption屬性進行操作，例如：caption=ll.l("name")前面提到在Js中國際化使用的是[(#{ })]

表單對日期格式的處理

通常需要將當前日期欄位進行格式化只需要下面程式碼即可：

field(property="birthday")
    label
    c-datepicker(displayFormat="yyyy-MM-dd" inputFormat="yyyy-MM-dd")

將datatype型別為Date的birthday欄位的文字顯示和選擇的日期格式調整為"yyyy-MM-dd"

表單對列舉值的處理

我們經常會把一些常規的資料做成列舉值存放在資料庫，並把頁面的文字輸入框改變成為下拉項

頁面元素

field(property="status")
    label
    c-dropdown(c-items="dictionary('10000')")

引入Js

script(src=basecodeCP + "controller/basecode/codeDetail/findCodeDetails?baseCodeIds=10000")

或者

script(src="controller/basecode/codeDetail/findCodeDetails?baseCodeIds=10000")

這樣頁面會去載入列舉值程式碼為10000的對應status存放的id對應的文字顯示到當前欄位，併為當前欄位提供下拉項

表單對文字域的處理

類似於備註，通常都是用文字框來顯示

fields.cols-1
    field(property="remark")
        label
        c-textarea(rows="3")

首先定義當前欄位獨佔一列，使用c-textarea(rows="3")表名當前欄位獨佔三列

表單對只讀的處理

正常場景並不是表單中列出的所有的欄位都是手動輸入的，比如ID，我們可以使用readOnly="true"對每個field進行只讀控制，也可以將readOnly="true"放在c-form屬性裡面來控制整個表單只讀

表單對省市縣級聯的處理

Jade

field(property="country"
    label
    c-dropdown(c-items="dictionary('CountryCode')" onSelectData="onCountrySelect")
(property="province" caption=ll.l("province") c-readOnly="queryCondition.country != 'CHN'")
    label
    c-dropdown(c-items="provinces" textProperty="name" assignment="province=kind" onSelectData="onProvinceSel")
field(property="city" caption=ll.l("city") c-readOnly="queryCondition.country != 'CHN'")
    label
    c-dropdown(c-items="cities" textProperty="name" assignment="city=kind" beforeOpen="beforeCityOpen" onSelectData="onCitySel")
field(property="county" caption=ll.l("county") c-readOnly="queryCondition.country != 'CHN'")
    label
    c-dropdown(c-items="counties" textProperty="name" assignment="county=kind" beforeOpen="beforeCountyOpen")

引入資料字典

script(src="controller/basecode/codeDetail/findCodeDetails?baseCodeIds=CountryCode")

Js

cola(function(model) {
    model.describe("provinces", {
        provider: {
            url: "controller/basecode/codeDetail/findCachedCodeDetails",
            parameter: {
                baseCodeId: "Address",
                parentId: "NULL"
            }
        }
    });
    model.set("title", "[(#{simple01})]");
    model.set("queryCondition", {"country":"CHN"});
    model.action({
        beforeCityOpen: function () {
            var province = model.get("queryCondition.province");
            $.ajax("controller/basecode/codeDetail/findCachedCodeDetails?baseCodeId=Address&parentId=" + province, {
                type: "get", async: false
            }).done(function (result) {
                if (result) {
                    model.set("cities", result);
                }
            });
        },
        beforeCountyOpen: function () {
            var city = model.get("queryCondition.city");
            $.ajax("controller/basecode/codeDetail/findCachedCodeDetails?baseCodeId=Address&parentId=" + city, {
                type: "get", async: false
            }).done(function (result) {
                if (result) {
                    model.set("counties", result);
                }
            });
        },
        onProvinceSel: function (self, arg) {
            var queryCondition = model.get("queryCondition");
            if(queryCondition.get("province") != arg.data.get("kind")){
                queryCondition.set("city", "");
                queryCondition.set("county", "");
            }
        },
        onCitySel: function (self, arg) {
            var queryCondition = model.get("queryCondition");
            if(queryCondition.get("city") != arg.data.get("kind")){
                queryCondition.set("county", "");
            }
        },
        onCountrySelect: function (self, arg) {
            var selectedItem = arg.data;
            if("CHN" != selectedItem.key) {
                model.get("queryCondition").set("province", "");
                model.get("queryCondition").set("city", "");
                model.get("queryCondition").set("county", "");
            }
        }
    });
});

表格相關

表格對列舉值的處理

通常我們都是在表單錄入資料，在表格中進行簡約展示，所以在表單中錄入的下拉列舉值我們需要在表格中使用的時候必須使用獲取到的列舉值進行翻譯

column(property="status")
    template
    div(c-bind="translate('10000',$default)")

表格對行內編輯的處理

在對於處理一些簡單資料的時候我們可以不需要彈出一個複雜的編輯框對當前行的資料進行編輯處理，可以直接在表格進行行內編輯

c-table(bind="simple01s" dataType="Simple01" readOnly="false")
表格行編輯對下拉項的處理

在表單編輯我們可以去選擇一個下拉項做為資料值，當然在表格行編輯也可以

column(property="status")
    template(name="edit")
        c-dropdown(bind="$default" c-items="dictionary('10000')")

最後程式碼整理為

column(property="status")
    template(name="edit")
        c-dropdown(bind="$default" c-items="dictionary('10000')")
    template
        div(c-bind="translate('10000',$default)")

表格新增操作列的處理

通常我們需要在表格的最後一列新增一行操作列來處理當前行的資料

c-table(bind="simple in simple01s" dataType="Simple01")
    column(caption=ll.l("operation"))
        template
            div
                a.cell-link(c-onclick="view(simple)")=ll.l("view")

表格聯動的處理

很多場景下，我們的資料和資料都是有關聯關係，比如一本書對應書籍的出版社的詳細資訊，這時候針對不同的書本資訊聯動到出版社的詳細資訊

因為此處是兩個表的關聯，所以需要定義兩個dataType

cModel.js

var $DataType = {
    A: {
        name: "A",
        properties : {
            name : {
                caption : "[(#{name})]",
                dataType : "string",
            }
        }
    },
    B : {
        name : "B",
        properties : {
            name : {
                caption : "[(#{name})]",
                dataType : "string"
            }
        }
    }
};

c.jade

c-table(bind="as" dataType="a")
    column(property="name")
c-table(bind="as#.bs" dataType="b")
    column(property="name")

c.js

cola(function(model) {
    model.dataType($DataType.B);
    $DataType.A.properties.bs = {
        dataType: "B",
        aggregated: true,
        provider: {
            url: "controller/B/find",
            sendJson: true,
            parameter: {
                "name": "{{@name}}"
            }
        }
    }
    model.dataType($DataType.A);
    model.describe("as", {
        dataType : "A",
        provider : {
            url : "controller/C/findPagination?from={{$from}}&limit={{$limit}}",
            pageSize : 10,
            sendJson : true,
            loadMode: 'manual'
        }
    });
    model.set("title", "[(#{C})]");
    model.action({
    });
});

在關聯中可以使用parameter:{"name":"{{@name}}"}方式拿到父表中當前選中行的name的值

表格資料載入的處理

在某些場景下我們可以讓表格資料直接載入到頁面，也可以使用事件來觸發載入資料

loadMode: 'manual'

可以通過loadMode來控制表單是否在頁面載入的時候載入資料到頁面：manual手工載入，註釋掉loadMode預設自動載入資料

皮膚Panel 相關

在panel頭位置新增按鈕

c-panel#panelDemo(caption=ll.l("panel"))
    template(name="tools")
       div
          c-button.primary(caption=ll.l("add") click="add")

其它

預載入處理

通常我們會在頁面載入完成的時候自動觸發一部分方法或者set一部分資料值到指定屬性

cola.ready(function() {
    cola.widget("panelDemo").collapse(); // 在載入完頁面之後 摺疊id為panelDemo的皮膚
});

程式碼應該放在cola(function (model) { })

相關文章