Merge pull request #72 from InhiblabCore/dev

inhiblab · web-flow · commit b2f308e4a498 · 2022-12-27T16:45:44.000+08:00
docs: nav-bar style
diff --git a/package.json b/package.json
@@ -33,8 +33,8 @@
 		"@types/qs": "^6.9.7",
 		"@vitejs/plugin-vue": "^2.3.1",
 		"@vue-hooks-plus/md-demo-plugins": "^1.0.0",
-		"@vue-hooks-plus/vitepress": "1.1.8",
-		"@vue-hooks-plus/vitepress-demo-block": "^1.2.7",
+		"@vue-hooks-plus/vitepress": "1.2.3",
+		"@vue-hooks-plus/vitepress-demo-block": "^1.3.1",
 		"@vue/test-utils": "^2.1.0",
     "@vitest/coverage-c8":"^0.25.7",
 		"eslint": "^8.20.0",
diff --git a/packages/hooks/docs/.vitepress/components/highlight/highlight.vue b/packages/hooks/docs/.vitepress/components/highlight/highlight.vue
@@ -0,0 +1,7 @@
+<template>
+  <div></div>
+</template>
+
+<script lang="ts" setup></script>
+
+<style scoped lang="less"></style>
diff --git a/packages/hooks/docs/.vitepress/config.ts b/packages/hooks/docs/.vitepress/config.ts
@@ -76,23 +76,24 @@ export default defineConfig({
         nav: [
           { text: 'Hooks', link: '/useRequest/' },
           {
-            text: '演练场',
+            text: '演武场',
             link: 'http://43.138.187.142:9000/vue-hooks-plus/vhp-playground/',
           },
           isGithub
             ? {
-                text: 'Gitee 镜像',
+                text: '国内镜像 🇨🇳',
                 link: 'https://inhiblab-core.gitee.io/docs/hooks/',
               }
-            : {
-                text: 'Github 站点',
-                link: 'https://inhiblabcore.github.io/docs/hooks/',
-              },
+            : null,
+          // {
+          //     text: 'Github 站点',
+          //     link: 'https://inhiblabcore.github.io/docs/hooks/',
+          //   },
           {
             text: '发行版本',
             link: 'https://github.com/InhiblabCore/vue-hooks-plus/releases/',
           },
-        ],
+        ].filter(Boolean),
         sidebar: getRouterConfig(),
       },
       '/en/': {
@@ -104,18 +105,15 @@ export default defineConfig({
           },
           isGithub
             ? {
-                text: 'Gitee Site',
+                text: 'Gitee Mirror 🇨🇳',
                 link: 'https://inhiblab-core.gitee.io/docs/hooks/',
               }
-            : {
-                text: 'Github Site',
-                link: 'https://inhiblabcore.github.io/docs/hooks/',
-              },
+            : null,
           {
             text: 'Releases',
             link: 'https://github.com/InhiblabCore/vue-hooks-plus/releases/',
           },
-        ],
+        ].filter(Boolean),
         sidebar: getRouterConfig('/en/'),
       },
     },
diff --git a/packages/hooks/docs/.vitepress/router.ts b/packages/hooks/docs/.vitepress/router.ts
@@ -148,7 +148,7 @@ const useRequestRouter = [
         link: '/useRequest/scroll/',
       },
       {
-        text: '🌟 开发插件',
+        text: '插件',
         link: '/useRequest/plugin/',
       },
     ],
@@ -217,7 +217,7 @@ const useRequestRouterEN = [
         link: '/en/useRequest/scroll/',
       },
       {
-        text: '🌟 Plugin',
+        text: 'Plugins',
         link: '/en/useRequest/plugin/',
       },
     ],
diff --git a/packages/hooks/docs/.vitepress/theme/var.less b/packages/hooks/docs/.vitepress/theme/var.less
@@ -20,6 +20,8 @@
     rgba(59, 206, 128, 0.7) 26%,
     rgba(100, 126, 255, 0.7) 76%
   );
+
+  --vhp-demo-shadow-color: rgba(0, 0, 0, 0.3);
 }
 
 .VPHome {
@@ -42,10 +44,10 @@ input {
 }
 
 .vitepress-demo {
-  border-radius: 15px;
+  border-radius: 12px;
   overflow: hidden;
   margin-top: 8px;
-  box-shadow: 0px 3px 6px rgba(0, 0, 0, 0.3);
+  box-shadow: 0px 2px 4px var(--vhp-demo-shadow-color);
 }
 
 .dark {
@@ -57,6 +59,7 @@ input {
     rgba(100, 126, 255, 0.7) 26%,
     rgba(59, 206, 128, 0.7) 76%
   );
+  --vhp-demo-shadow-color: rgba(188, 189, 190, 0.3);
 }
 
 .vp-doc [class*='language-']:before {
diff --git a/packages/hooks/src/useCookieState/index.en-US.md b/packages/hooks/src/useCookieState/index.en-US.md
@@ -38,7 +38,11 @@ const [state, setState]: [State, SetState] = useCookieState(
 );
 ```
 
-Note: If you want to remove this data from the document.cookie, use the `setState()` or `setState (undefined)`.
+:::tip Note
+
+If you want to remove this data from the document.cookie, use the `setState()` or `setState (undefined)`.
+
+:::
 
 ### Params
 
diff --git a/packages/hooks/src/useCookieState/index.zh-CN.md b/packages/hooks/src/useCookieState/index.zh-CN.md
@@ -15,16 +15,14 @@ map:
 <demo src="./demo/demo.vue"
   language="vue"
   title="将状态存储在 Cookie 中"
-  desc="刷新页面后，可以看到输入框中的内容被从 Cookie 中恢复了。">
-</demo>
+  desc="刷新页面后，可以看到输入框中的内容被从 Cookie 中恢复了。"> </demo>
 
 ### 高级用法-可接收函数
 
 <demo src="./demo/demo1.vue"
   language="vue"
   title="set可接收函数"
-  desc="set的时候可以接收函数进行拓展使用">
-</demo>
+  desc="set的时候可以接收函数进行拓展使用"> </demo>
 
 ## API
 
@@ -40,7 +38,11 @@ const [state, setState]: [State, SetState] = useCookieState(
 );
 ```
 
-注意：如果想从 document.cookie 中删除这条数据，可以使用 `setState()` 或 `setState(undefined)`。
+:::tip 注意
+
+如果想从 document.cookie 中删除这条数据，可以使用 `setState()` 或 `setState(undefined)`。
+
+:::
 
 ### Params
 
@@ -51,24 +53,24 @@ const [state, setState]: [State, SetState] = useCookieState(
 
 ### Result
 
-| 参数     | 说明           | 类型                    |
-| -------- | -------------- | ----------------------- |
+| 参数     | 说明           | 类型                         |
+| -------- | -------------- | ---------------------------- |
 | state    | 本地 Cookie 值 | `Ref<string` \| `undefined>` |
-| setState | 设置 Cookie 值 | `SetState`              |
+| setState | 设置 Cookie 值 | `SetState`                   |
 
 setState 可以更新 cookie options，会与 `useCookieState` 设置的 options 进行 merge 操作。
 
 `const targetOptions = { ...options, ...updateOptions }`
 
 ### Options
 
-| 参数         | 说明                                                 | 类型                                                       | 默认值      |
-| ------------ | ---------------------------------------------------- | ---------------------------------------------------------- | ----------- |
-| defaultValue | 可选，定义 Cookie 默认值，但不同步到本地 Cookie      | `string` \| `undefined` \| `(() => (string \| undefined))` | `undefined` |
-| expires      | 可选，定义 Cookie 存储有效时间                       | `number` \| `Date`                                         | -           |
-| path         | 可选，定义 Cookie 可用的路径                         | `string`                                                   | `/`         |
-| domain       | 可选，定义 Cookie 可用的域，默认为 Cookie 创建的域名 | `string`                                                   | -           |
-| secure       | 可选，Cookie 传输是否需要 https 安全协议             | `boolean`                                                  | `false`     |
-| sameSite     | 可选，Cookie 不能与跨域请求一起发送                  | `strict` \| `lax` \| `none`                                | -           |
+| 参数 | 说明 | 类型 | 默认值 |
+| --- | --- | --- | --- |
+| defaultValue | 可选，定义 Cookie 默认值，但不同步到本地 Cookie | `string` \| `undefined` \| `(() => (string \| undefined))` | `undefined` |
+| expires | 可选，定义 Cookie 存储有效时间 | `number` \| `Date` | - |
+| path | 可选，定义 Cookie 可用的路径 | `string` | `/` |
+| domain | 可选，定义 Cookie 可用的域，默认为 Cookie 创建的域名 | `string` | - |
+| secure | 可选，Cookie 传输是否需要 https 安全协议 | `boolean` | `false` |
+| sameSite | 可选，Cookie 不能与跨域请求一起发送 | `strict` \| `lax` \| `none` | - |
 
 Options 与 [js-cookie attributes](https://github.com/js-cookie/js-cookie#cookie-attributes) 保持一致。
diff --git a/packages/hooks/src/useLocalStorageState/index.en-US.md b/packages/hooks/src/useLocalStorageState/index.en-US.md
@@ -55,6 +55,8 @@ const [state, setState] = useLocalStorageState<T>(
 | state    | Local Storage-value | `Ref<any` \| `undefined>` |
 | setState | Set Storage value   | `SetState`                |
 
-## Remark
+:::warning Remark
 
 useLocalStorageState will call `serializer` before write data to localStorage, and call `deserializer` once after read data.
+
+:::
diff --git a/packages/hooks/src/useLocalStorageState/index.zh-CN.md b/packages/hooks/src/useLocalStorageState/index.zh-CN.md
@@ -55,6 +55,8 @@ const [state, setState] = useLocalStorageState<T>(
 | state    | 本地 Storage 值 | `Ref<any` \| `undefined>` |
 | setState | 设置 Storage 值 | `SetState`                |
 
-## 注意
+:::warning 注意
 
 useLocalStorageState 在往 localStorage 写入数据前，会先调用一次 `serializer`，在读取数据之后，会先调用一次 `deserializer`。
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/basic/index.en-US.md b/packages/hooks/src/useRequest/docs/basic/index.en-US.md
@@ -201,4 +201,8 @@ const {
 | onError | Triggered when service reject | `(e: Error, params: TParams) => void` | - |
 | onFinally | Triggered when service execution is complete | `(params: TParams, data?: TData, e?: Error) => void` | - |
 
+:::info 🛸 PRO
+
 Above we have introduced the most basic functionalities of useRequest, and then we will introduce some more advanced functionalities.
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/basic/index.zh-CN.md b/packages/hooks/src/useRequest/docs/basic/index.zh-CN.md
@@ -198,4 +198,8 @@ const {
 | onError | service reject 时触发 | `(e: Error, params: TParams) => void` | - |
 | onFinally | service 执行完成时触发 | `(params: TParams, data?: TData, e?: Error) => void` | - |
 
+:::info 🛸 PRO
+
 这是 useRequest 最基础的功能，接下来介绍一些更高级的能力。
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/cache/index.en-US.md b/packages/hooks/src/useRequest/docs/cache/index.en-US.md
@@ -55,11 +55,13 @@ provides a `clearCache` method, which can clear the cache data of the specified
 
 By setting `setCache` and `getCache`, you can customize the cache, for example, you can store data in `localStorage, IndexDB`, etc.
 
-Please note:
+::: tip Please note
 
 1. `setCache` and `getCache` need to be used together.
 2. In the custom cache mode, `cacheTime` and `clearCache` will be unused, please implement it yourself according to the actual situation.
 
+:::
+
 <demo src="./demo/demo4.vue"
   language="vue"
   title=""
@@ -95,7 +97,9 @@ clearCache(cacheKey?: string | string[]);
 1. Support clearing a single cache, or a group of caches
 2. If `cacheKey` is empty, all cached data will be cleared
 
-# Remark
+::: warning Remark
 
 - Only successful request data will be cached
 - Cached data includes `data` and `params`
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/cache/index.zh-CN.md b/packages/hooks/src/useRequest/docs/cache/index.zh-CN.md
@@ -55,11 +55,13 @@ map:
 
 通过配置 `setCache` 和 `getCache`，可以自定义数据缓存，比如可以将数据存储到 `localStorage`、`IndexDB` 等。
 
-请注意：
+::: tip 请注意
 
 1. `setCache` 和 `getCache` 需要配套使用。
 2. 在自定义缓存模式下，`cacheTime` 和 `clearCache` 不会生效，请根据实际情况自行实现。
 
+:::
+
 <demo src="./demo/demo4.vue"
   language="vue"
   title=""
@@ -95,7 +97,9 @@ clearCache(cacheKey?: string | string[]);
 1. 支持清空单个缓存，或一组缓存
 2. 如果 `cacheKey` 为空，则清空所有缓存数据
 
-## 注意
+::: warning 注意
 
 - 只有成功的请求数据才会缓存
 - 缓存的数据包括 `data` 和 `params`
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/debounce/index.en-US.md b/packages/hooks/src/useRequest/docs/debounce/index.en-US.md
@@ -26,10 +26,12 @@ The usage and effect of all debounce property are the same as [lodash.debounce](
 | debounceTrailing | Execute the request after the delay ends | `boolean`\|`Ref<boolean>` | `true` |
 | debounceMaxWait | The maximum time request is allowed to be delayed before it’s executed | `number`\|`Ref<number>` | - |
 
-## Remark
+::: warning Remark
 
 - `options.debounceLeading` support dynamic changes.
 - `options.debounceTrailing` support dynamic changes.
 - `options.debounceMaxWait` support dynamic changes.
 - `runAsync` will return a `Promise` when it is actually executed. When it is not executed, there will be no return.
 - `cancel` can abort a function waiting to be executed.
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/debounce/index.zh-CN.md b/packages/hooks/src/useRequest/docs/debounce/index.zh-CN.md
@@ -26,10 +26,12 @@ debounce 所有参数用法和效果同 [lodash.debounce](https://www.lodashjs.c
 | debounceTrailing | 在延迟结束后执行调用 | `boolean`\|`Ref<boolean>` | `true` |
 | debounceMaxWait | 允许被延迟的最大值 | `number`\|`Ref<number>` | - |
 
-## 注意
+::: warning 注意
 
 - `options.debounceLeading` 支持动态变化。
 - `options.debounceTrailing` 支持动态变化。
 - `options.debounceMaxWait` 支持动态变化。
 - `runAsync` 在真正执行时，会返回 `Promise`。在未被执行时，不会有任何返回。
 - `cancel` 可以中止正在等待执行的函数。
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/index.en-US.md b/packages/hooks/src/useRequest/docs/index.en-US.md
@@ -4,9 +4,15 @@ map:
   path: /useRequest/
 ---
 
-# 🚀 useRequest
+# Quick Start
 
-With a strong ability to manage network requests, Hook has a flying experience <br /> <br />
+:::tip 🚀 useRequest
+
+With a strong ability to manage network requests, Hook has a flying experience
+
+:::
+
+<br />
 
 `useRequest` Through the plug-in organization code, the core code is easy to understand, and can be easily expanded to more advanced functions. Capacity is now available to include
 
diff --git a/packages/hooks/src/useRequest/docs/index.zh-CN.md b/packages/hooks/src/useRequest/docs/index.zh-CN.md
@@ -4,9 +4,15 @@ map:
   path: /useRequest/
 ---
 
-# 🚀 useRequest
+# 快速开始
 
-拥有强大管理网络请求能力，让开发具有飞一般的体验 的 Hook <br /> <br />
+:::tip 🚀 useRequest
+
+拥有强大管理网络请求能力，让开发具有飞一般的体验 的 Hook
+
+:::
+
+<br />
 
 `useRequest` 通过插件式组织代码，核心代码简单易懂，并且可以很方便的扩展出更高级的功能。目前已有能力包括：
 
diff --git a/packages/hooks/src/useRequest/docs/pluginDoc/index.en-US.md b/packages/hooks/src/useRequest/docs/pluginDoc/index.en-US.md
@@ -79,10 +79,12 @@ interface PluginReturn<TData, TParams extends any[]> {
 }
 ```
 
-### ⚠️ Remark
+:::tip Remark
 
 Need to setup `data`, `params`, `loading`, `error` Change requires use using the `setData` on the instance.
 
+:::
+
 ## Develop a simple filtering plugin
 
 <demo src="./demo/demo.vue"
diff --git a/packages/hooks/src/useRequest/docs/pluginDoc/index.zh-CN.md b/packages/hooks/src/useRequest/docs/pluginDoc/index.zh-CN.md
@@ -79,10 +79,12 @@ interface PluginReturn<TData, TParams extends any[]> {
 }
 ```
 
-### ⚠️ 注意
+:::tip 注意
 
 需要设置 `data` 、`params` 、 `loading` 、 `error` 需要使用实例上的 `setData` 进行变更。
 
+:::
+
 ## 开发一个简单的过滤插件
 
 <demo src="./demo/demo.vue"
diff --git a/packages/hooks/src/useRequest/docs/polling/index.en-US.md b/packages/hooks/src/useRequest/docs/polling/index.en-US.md
@@ -31,9 +31,11 @@ By setting `options.pollingInterval`, enter the polling mode, `useRequest` will
 | pollingWhenHidden | Whether to continue polling when the page is hidden. If set to false, polling will be temporarily paused when the page is hidden, and resume when the page is visible again. | `boolean` | `true` |
 | pollingErrorRetryCount | Number of polling error retries. If set to -1, an infinite number of times | `number` | `-1` |
 
-# Remark
+:::warning Remark
 
 - `options.pollingInterval` support dynamic changes.
 - `options.pollingWhenHidden` support dynamic changes.
 - If you set `options.manual = true`, the initialization will not start polling, you need start it by `run/runAsync`.
 - The polling logic is to wait for `pollingInterval` time after each request is completed, and then initiate the next request.
+
+:::
diff --git a/packages/hooks/src/useRequest/docs/polling/index.zh-CN.md b/packages/hooks/src/useRequest/docs/polling/index.zh-CN.md
diff --git a/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.en-US.md b/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.en-US.md
diff --git a/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.zh-CN.md b/packages/hooks/src/useRequest/docs/refreshOnWindowFocus/index.zh-CN.md
diff --git a/packages/hooks/src/useRequest/docs/retry/index.en-US.md b/packages/hooks/src/useRequest/docs/retry/index.en-US.md
diff --git a/packages/hooks/src/useRequest/docs/retry/index.zh-CN.md b/packages/hooks/src/useRequest/docs/retry/index.zh-CN.md
diff --git a/packages/hooks/src/useRequest/docs/throttle/index.en-US.md b/packages/hooks/src/useRequest/docs/throttle/index.en-US.md
diff --git a/packages/hooks/src/useRequest/docs/throttle/index.zh-CN.md b/packages/hooks/src/useRequest/docs/throttle/index.zh-CN.md
diff --git a/packages/hooks/src/useUpdate/index.en-US.md b/packages/hooks/src/useUpdate/index.en-US.md
diff --git a/packages/hooks/src/useUpdate/index.zh-CN.md b/packages/hooks/src/useUpdate/index.zh-CN.md
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`rgba(59, 206, 128, 0.7) 26%,`
`21`	`21`	`rgba(100, 126, 255, 0.7) 76%`
`22`	`22`	`);`
	`23`	`+`
	`24`	`+ --vhp-demo-shadow-color: rgba(0, 0, 0, 0.3);`
`23`	`25`	`}`
`24`	`26`
`25`	`27`	`.VPHome {`
`@@ -42,10 +44,10 @@ input {`
`42`	`44`	`}`
`43`	`45`
`44`	`46`	`.vitepress-demo {`
`45`		`- border-radius: 15px;`
	`47`	`+ border-radius: 12px;`
`46`	`48`	`overflow: hidden;`
`47`	`49`	`margin-top: 8px;`
`48`		`- box-shadow: 0px 3px 6px rgba(0, 0, 0, 0.3);`
	`50`	`+ box-shadow: 0px 2px 4px var(--vhp-demo-shadow-color);`
`49`	`51`	`}`
`50`	`52`
`51`	`53`	`.dark {`
`@@ -57,6 +59,7 @@ input {`
`57`	`59`	`rgba(100, 126, 255, 0.7) 26%,`
`58`	`60`	`rgba(59, 206, 128, 0.7) 76%`
`59`	`61`	`);`
	`62`	`+ --vhp-demo-shadow-color: rgba(188, 189, 190, 0.3);`
`60`	`63`	`}`
`61`	`64`
`62`	`65`	`.vp-doc [class*='language-']:before {`