kn-hooks 0.0.17 → 0.0.19

package/md/useDictionary.md

@@ -22,6 +22,12 @@
 | params.SelectOption | <code>ReactDom</code> | Antd的SelectOption组件 |
 | params.RadioOption | <code>ReactDom</code> | Antd的SelectOption组件 |
 
+**Example**  
+```js
+import {useDictionary} from 'kn-hooks';
+  import {Select,Radio} from 'antd';
+  useDictionary.SetConfig(Select.Option,Radio.Option);
+```
 <a id="module_usedictionary_createdictionary"></a>
 ### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">M</span>        createDictionary(options) ⇒ <code>callback</code>
 创建字典hooks工具
@@ -43,7 +49,8 @@
 **Example**  
 ```js
 // emUserType.jsx
-  export const userType = createDictionary({
+    import {useDictionary} from 'kn-hooks';
+  export const userType = useDictionary.createDictionary({
     api:()=>Promise.resolve([{id:'1001',label:'项目1001',name:'pm1001'},]),
     afterApi:(response)=>{
       return response?.data;

package/md/usePagination.md

@@ -3,6 +3,8 @@
 
 * [    usePagination](#module_usepagination)
     * [    usePagination(props)](#module_usepagination__usepagination) ⇒ <code>UsePaginationResult</code>
+    * [    FunServices()](#module_usepagination__funservices) ⇒ <code>FunServicesCallback</code>
+    * [    FunServicesCallback](#module_usepagination__funservicescallback) : <code>Object</code>
     * [    Pagination](#module_usepagination__pagination) : <code>Object</code>
     * [    PageDataResult](#module_usepagination__pagedataresult) : <code>Object</code>
     * [    FunUpdate](#module_usepagination__funupdate) ⇒ <code>Promise.&lt;PageDataResult&gt;</code>
@@ -18,7 +20,7 @@
 | Param | Type | Description |
 | --- | --- | --- |
 | props | <code>Object</code> |  |
-| props.service | <code>function</code> | 发送请求的方法,默认分页使用current和pageSize，如有特殊需求通过beforeService拦截处理 |
+| props.service | <code>FunServices</code> | 发送请求的方法 |
 | [props.pagination] | <code>Pagination</code> | 默认分页信息 |
 
 **Example**  
@@ -27,7 +29,6 @@
   const page = usePagination({
     service:GET_LIST,
     pagination:{pageSize:10},
-    
   });
 
   useEffect(()=>{
@@ -45,8 +46,7 @@
         data:response.list,
         page:response.pageInfo
       };
-      response.code=response;
-      return response;
+      return req;
     },
 
     page.addListener('beforeService',fnFeforeService);
@@ -88,6 +88,33 @@
     </ul>
   )
 ```
+<a id="module_usepagination__funservices"></a>
+### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">M</span>        FunServices() ⇒ <code>FunServicesCallback</code>
+分页请求接口格式要求
+
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| current | <code>number</code> | <code>1</code> | 页码 |
+| pageSize | <code>number</code> | <code>10</code> | 分页大小 |
+| ...others | <code>any</code> |  | 其它接口附带参数 |
+
+<a id="module_usepagination__funservicescallback"></a>
+### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">T</span>        FunServicesCallback : <code>Object</code>
+分页接口请求结果
+
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| code | <code>number</code> | <code>0</code> | 接口调用结果，0为成功 |
+| data | <code>Array.&lt;Object&gt;</code> |  | 分页数据 |
+| page | <code>Object</code> |  | 分页信息 |
+| page.current | <code>number</code> |  | 页码 |
+| page.pageSize | <code>number</code> |  | 分页大小 |
+| page.total | <code>number</code> |  | 数据总量 |
+
 <a id="module_usepagination__pagination"></a>
 ### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">T</span>        Pagination : <code>Object</code>
 分页信息

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kn-hooks",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "scripts": {
     "dev": "cross-env env_api=dev env_package=dev webpack-dev-server --progress",
     "build": "cross-env env_api=prod env_package=prod webpack --config webpack.config.js",

package/readme.md

@@ -171,6 +171,12 @@ return <span>当前计数器:{counter.count}</span>
 | params.SelectOption | <code>ReactDom</code> | Antd的SelectOption组件 |
 | params.RadioOption | <code>ReactDom</code> | Antd的SelectOption组件 |
 
+**Example**  
+```js
+import {useDictionary} from 'kn-hooks';
+  import {Select,Radio} from 'antd';
+  useDictionary.SetConfig(Select.Option,Radio.Option);
+```
 <a id="module_usedictionary_createdictionary"></a>
 ### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">M</span>        createDictionary(options) ⇒ <code>callback</code>
 创建字典hooks工具
@@ -192,7 +198,8 @@ return <span>当前计数器:{counter.count}</span>
 **Example**  
 ```js
 // emUserType.jsx
-  export const userType = createDictionary({
+    import {useDictionary} from 'kn-hooks';
+  export const userType = useDictionary.createDictionary({
     api:()=>Promise.resolve([{id:'1001',label:'项目1001',name:'pm1001'},]),
     afterApi:(response)=>{
       return response?.data;
@@ -311,6 +318,8 @@ const Index=()=>{
 
 * [    usePagination](#module_usepagination)
     * [    usePagination(props)](#module_usepagination__usepagination) ⇒ <code>UsePaginationResult</code>
+    * [    FunServices()](#module_usepagination__funservices) ⇒ <code>FunServicesCallback</code>
+    * [    FunServicesCallback](#module_usepagination__funservicescallback) : <code>Object</code>
     * [    Pagination](#module_usepagination__pagination) : <code>Object</code>
     * [    PageDataResult](#module_usepagination__pagedataresult) : <code>Object</code>
     * [    FunUpdate](#module_usepagination__funupdate) ⇒ <code>Promise.&lt;PageDataResult&gt;</code>
@@ -326,7 +335,7 @@ const Index=()=>{
 | Param | Type | Description |
 | --- | --- | --- |
 | props | <code>Object</code> |  |
-| props.service | <code>function</code> | 发送请求的方法,默认分页使用current和pageSize，如有特殊需求通过beforeService拦截处理 |
+| props.service | <code>FunServices</code> | 发送请求的方法 |
 | [props.pagination] | <code>Pagination</code> | 默认分页信息 |
 
 **Example**  
@@ -335,7 +344,6 @@ const Index=()=>{
   const page = usePagination({
     service:GET_LIST,
     pagination:{pageSize:10},
-    
   });
 
   useEffect(()=>{
@@ -353,8 +361,7 @@ const Index=()=>{
         data:response.list,
         page:response.pageInfo
       };
-      response.code=response;
-      return response;
+      return req;
     },
 
     page.addListener('beforeService',fnFeforeService);
@@ -396,6 +403,33 @@ const Index=()=>{
     </ul>
   )
 ```
+<a id="module_usepagination__funservices"></a>
+### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">M</span>        FunServices() ⇒ <code>FunServicesCallback</code>
+分页请求接口格式要求
+
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| current | <code>number</code> | <code>1</code> | 页码 |
+| pageSize | <code>number</code> | <code>10</code> | 分页大小 |
+| ...others | <code>any</code> |  | 其它接口附带参数 |
+
+<a id="module_usepagination__funservicescallback"></a>
+### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">T</span>        FunServicesCallback : <code>Object</code>
+分页接口请求结果
+
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| code | <code>number</code> | <code>0</code> | 接口调用结果，0为成功 |
+| data | <code>Array.&lt;Object&gt;</code> |  | 分页数据 |
+| page | <code>Object</code> |  | 分页信息 |
+| page.current | <code>number</code> |  | 页码 |
+| page.pageSize | <code>number</code> |  | 分页大小 |
+| page.total | <code>number</code> |  | 数据总量 |
+
 <a id="module_usepagination__pagination"></a>
 ### <span style="display:inline-flex;align-items:center;justify-content:center;width:34px;height:34px;border-radius:4px;color:rgb(71, 128, 227);background:#ede6e6;">T</span>        Pagination : <code>Object</code>
 分页信息

package/src/usePagination/index.js

@@ -6,9 +6,12 @@ import { useState,useMemo,useRef } from 'react';
 
 /**
  * 分页管理器
+ * 
+ * 
  * @param {Object} props 
- * @param {function} props.service - 发送请求的方法,默认分页使用current和pageSize，如有特殊需求通过beforeService拦截处理
+ * @param {FunServices} props.service - 发送请求的方法
  * @param {Pagination} [props.pagination] - 默认分页信息
+ * 
  * @version 1.0.0
  * 
  * @example 
@@ -16,7 +19,6 @@ import { useState,useMemo,useRef } from 'react';
   const page = usePagination({
     service:GET_LIST,
     pagination:{pageSize:10},
-    
   });
 
   useEffect(()=>{
@@ -34,8 +36,7 @@ import { useState,useMemo,useRef } from 'react';
         data:response.list,
         page:response.pageInfo
       };
-      response.code=response;
-      return response;
+      return req;
     },
 
     page.addListener('beforeService',fnFeforeService);
@@ -211,6 +212,30 @@ const usePagination=(props)=>{
 
 
 
+/**
+ * 分页接口请求结果
+ * @typedef {Object} FunServicesCallback
+ * @property {number} code=0 - 接口调用结果，0为成功
+ * @property {Object[]} data - 分页数据
+ * @property {Object} page  - 分页信息
+ * @property {number} page.current - 页码
+ * @property {number} page.pageSize - 分页大小
+ * @property {number} page.total - 数据总量
+ * 
+ */
+
+
+/**
+ * @function  
+ * @name FunServices
+ * @description 分页请求接口格式要求
+ * @property {number} current=1 - 页码
+ * @property {number} pageSize=10 - 分页大小
+ * @property {...any} others  - 其它接口附带参数
+ * @return {FunServicesCallback}
+ */
+
+
 /**
  * 分页信息
  * @typedef {Object} Pagination