framework-hook v0.0.4

framework-hook

介绍

framework sdk的数据处理

软件架构

软件架构说明

安装教程

yarn add framework-hook

使用说明

1. 初始化数据

   • 通过 FrameworkProvider 初始化数据

       import {StrictMode} from 'react';
       import {render} from 'react-dom';
       import {FrameworkProvider} from 'framework-hook';
       import App from '@/modules/App';
       const main = (value: any) => render(
           <StrictMode>
               <FrameworkProvider value={value} projectName="csm">
                   <App />
               </FrameworkProvider>
           </StrictMode>,
           document.querySelector('#main')
       );
   
       window.framework.boot().then(async initData => {
           main(initData);
           // regionSwitchHandler 是 APP 处理 Region 切换之后逻辑的函数
           window.framework.events.on(window.framework.EVENTS.AFTER_REGION_CHANGED, e => {
               initData.region.id = e.data;
               main({...initData}); // 给一个新对象，这样内部的 才能检测到数据发生变化
           }, this);
       });

2. 方法

   • useRegion

   interface IRegion { // Region 返回的 类型
       // 当前 地域
       currentRegion: string;
       // 地域列表
       regionList: IRegionList;
       // 地域 datasource 数据
       datasource: ILabelValue[];
       // 获取 所有地域数据，默认为当前项目的地域
       getAllRegionList(projectName?: string): {
           list: IRegionList;
           datasource: ILabelValue[];
       };
       // 获取 相应产品的导航地域，默认为 本产品的
       getRegionList: (projectName: string) => IRegionList ;
       // 设置导航地域
       setRegion(regionId: string): any;
       // 设置 请求都中的 header
       setRequestHeaderRegion(regionId: string): any;
       // 监听导航地域的切换
       onRegionChange(callback: (e: any) => void): any;
       // 取消监听地域导航
       unRegionChange(callback: (e: any) => void): any;
   }

   • useAccount

   interface IAccount {
       // 用户id
       userId: string;
       // 是否个人认证
       verifyStatus: boolean;
   }

   • useFramework

   interface IUseFramework {
       region: IRegion; // useRegion 的数据
       account: IAccount; // useAccount 的数据
   }

   • FrameworkProvider

   <FrameworkProvider value={framework的数据} name={产品名称}>
       <App />
   </FrameworkProvider>

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/