iov-pro-components 0.0.3

package/docs/components/request.md

@@ -0,0 +1,44 @@
+# 接口请求 Request
+
+## 基本使用
+
+::: demo
+```html
+<template>
+  <iov-pro-request
+    :api="apiMock"
+    :params="params"
+  >
+    <template #default="{ data, loading }">接口加载状态：{{ loading }}，返回值：{{ data }}</template>
+  </iov-pro-request>
+</template>
+
+<script>
+const apiMock = (params) => {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => resolve({ name: '郭靖', sex: '男', age: 52 }), 300)
+  })
+}
+
+export default {
+  data() {
+    return {
+      apiMock,
+      params: { name: '' }
+    }
+  }
+}
+</script>
+```
+:::
+
+## Request Attributes
+
+| 参数 | 说明 | 类型 | 可选值 | 默认值 |
+| ------- | ------- | ------- | ------- | ------- |
+| api | 接口请求方法 | Function(params) | -  | - |
+| params | 接口请求入参 | Object | - | - |
+| reloadOnParamsChange | 当params发生变化，是否重新请求接口 | Boolean | - | true |
+| requiredFields | 接口请求必须的字段 | String/Array | - | - |
+| default | 接口没有加载成功前的默认值 | Array/Object | - | - |
+| threshold | 接口请求的阈值间隔 | Number | - | 50 |