orcrist-mobile

兽咬剑 JS 家族：React WebApp 端组件库

OrcristJS Family : React WebApp Components.

代码风格

TypeScript

组件列表

1. cnpm i orcrist-blade --save
2. import { Login } from 'orcrist-blade';
3. 页面调用：Login.LoginP();
4. 组件：

<Login.LoginC
    callback={this.LogIn}
    isPopup={this.state.isSendingComponent}
    phoneNumber={this.state.phoneNumber}
    closeNumberCodeHandle={this.closeLogin}
/>

4. 组件(带有输入手机号的组件)： |参数|备注| |callback|登录成功后的回调函数| |isPopup|是否拉起组件，true：显示组件，false：关闭组件| |closeNumberCodeHandle|关闭弹窗，需要将isPopup的值设置关闭|

<Login.LoginM
    callback={this.LogIn}
    isPopup={true/false}
    closeNumberCodeHandle={this.closeLogin}
/>

| 组件 | 用途 | 比传参数 | 可选参数 | | ------------ | -------- | ----------------------------------------- | -------- | | Login.LoginP | 页面使用 | Login.LoginP() | | | Login.LoginC | 调用组件 | isPopup,phoneNumber,closeNumberCodeHandle | callback |

|参数|参数值作用| |isPopup|进行登录| |phoneNumber|手机号码| |closeNumberCodeHandle|登录组件开关设置| |callback|成功回调函数|

开发流程

$ npm install
$ npm start

进入开发

1. 创建独立开发分支：git checkout -b feat/xxComponent 分支
2. 在 components 目录下创建你的组件文件夹
3. 在 components/index.ts 文件中为组件进行 export
4. 在 demo 目录中添加你的演示路由
5. 开发并自测
6. commit & push

发布代码

1. 提 pr 至 master 分支
2. 发布 npm
3. push master

$ npm publish
$ git commit -m "feat: add XXX"
$ git push

Project 中使用组件

import { YourComponent } from "orcrist-ui";

目录结构

├── AUTHORS.txt             作者(TODO)
├── CHANGELOG.xxx.md        变更记录文档(TODO)
├── LICENSE                 许可证(TODO
├── README.md               自述文档
├── ant-design-analysis     包分析(TODO)
├── components              组件代码
├── development.xxx.md      开发说明文档(TODO)
├── docs                    其他文档(TODO)
├── scripts                 辅助脚本(TODO)
├── tests                   通用测试代码(TODO)
├── tsconfig.json           TypeScript配置
├── typings                 第三方缺失定义

欢迎指正