0.1.0 • Published 6 years ago

@kbfe/kos v0.1.0

Weekly downloads
-
License
-
Repository
-
Last release
6 years ago

KOS

一款基于react-redux的数据流管理框架,简单轻量,目标是在多端体系下均能使用,与单页和多页方案无关,KOS配合脚手架生成的应用模板,来提供单页多页应用的使用场景

KOS

KOS.use(middleware)

  • 说明: 新增middleware
  • 参数:
  • middleware: redux中间件
  • 返回值:

KOS.start(App,Container='#main')

  • 说明: 启动应用,单页应用和多页应用均调用这个API
  • 参数:
  • App: React.Component
  • Container: React.Component渲染到的DOM节点,默认是id为main的节点
  • 说明: 用于启动一个应用程序

KOS.Wrapper(config)(Component)

  • 说明: 将Component使用Wrapper组件进行包装后,挂在到connect下面,用户将Model和View进行包装
  • 参数:
  • config.model: 需要绑定的model,model说明详见 Model
  • config.autoLoad: 在执行到Wrapper的componentDidMount的时候,是否自动执行Model.setup方法
  • 返回值: 和Model结合之后的高阶组件
  • 特别说明: 在项目中,通常建议的使用方式是:
import React from 'react';
import KOS form '@ali/kos';
import model from './model';

@KOS.Wrapper({model})
const class App extends React.Component({
  render(){
    return <div></div>
  }
})

KOS.registerModel(mode)

  • 说明: 注册model,KOS.Wrapper高阶组件会调用
  • 参数:
  • model: 需要注册的model
  • 返回值: 返回Model对象,注意:此处的Model对象非KOS.Wrapper({model}),时传入的model

KOS.getModel(namespace)

  • 说明: 根据namespace获取Model对象
  • 参数:
  • namepace: