Skip to content

Latest commit

 

History

History
201 lines (146 loc) · 4.65 KB

README_zh.md

File metadata and controls

201 lines (146 loc) · 4.65 KB
Raw

kabanery

中文文档 document

数据驱动易于组合的组件定义模式

安装

npm i kabanery --save 或者 npm i kabanery --save-dev

全局安装, 使用 npm i kabanery -g

特征

  • 简单的DOM DSL，快速构建DOM结构

  • 数据驱动视图，包括通过数据更新视图

  • 以函数为核心，易于复合

使用方法

API 快速运行

用方法n快速构造dom节点

let kabanery = require('kabanery')
let {n, mount} = kabanery;

mount(n('div', {
  id: 'qu',
  style: {
     backgroundColor: 'red'
  }
}, [
     n('span class=go style="font-size:16px"', 'hello!')
]), document.body);

console.log(document.getElementById('qu').outerHTML); // print result
输出

    <div id="qu" style="background-color: red"><span class="go" style="font-size:16px">hello!</span></div>

构造一个组件的简单方法

let kabanery = require('kabanery')
let {view, n, mount} = kabanery;

let MyView = view((data) => {
     let {type} = data;

     return n('div', {
        id: 'test1',
        style: {
           fontSize: 10
        }
     },[
         type === 2 && n('span', 'second'),
         type === 3 && n('div', 'third')
     ]);
});

mount(MyView({type: 3}), document.body);

console.log(document.getElementById('test1').outerHTML); // print result
输出

    <div id="test1" style="font-size: 10px"><div>third</div></div>

运用update api去更新一个view

let kabanery = require('kabanery')
let {view, n, mount} = kabanery;

let MyView = view((data, {update}) => {
     return n('div', {
        id: 'a',
        style: {
           fontSize: 10
        },
        onclick: () => {
           update('show', !data.show);
        }
     }, [
         data.show && n('div', 'show text')
     ]);
});

mount(MyView({show: false}), document.body);

document.getElementById('a').click(); // simulate user action
console.log(document.getElementById('a').outerHTML); // print result
输出

    <div id="a" style="font-size: 10px"><div>show text</div></div>

开发

文件结构

.    
│──LICENSE    
│──README.md    
│──README_zh.md    
│──index.js    
│──package.json    
│──src    
│   │──compose    
│   │   └──N.js    
│   │──event    
│   │   │──eventMatrix.js    
│   │   └──index.js    
│   │──index.js    
│   │──mount.js    
│   │──n    
│   │   │──index.js    
│   │   │──parseArgs.js    
│   │   └──parseAttribute.js    
│   │──ncn    
│   │   └──index.js    
│   │──reduceNode.js    
│   └──view.js    
│──test    
│   │──browser    
│   │   │──__test    
│   │   │   └──base.js    
│   │   │       │──index.html    
│   │   │       │──index.js    
│   │   │       │──test.js    
│   │   │       └──webpack.config.js    
│   │   └──case    
│   └──function    
│       │──browser.js    
│       │──index.js    
│       └──serverSide.js    
└──todo.md

运行测试用例

npm test

许可证

The MIT License (MIT)

Copyright (c) 2016 chenjunyu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.