chore: fix docs

dewfall123 · Apr 21, 2021 · 65b5e15 · 65b5e15
1 parent a9df58a
commit 65b5e15
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 17 deletions.
diff --git a/package.json b/package.json
@@ -68,7 +68,7 @@
     "screenfull": "^5.1.0",
     "ts-jest": "^25.2.1",
     "typescript": "^4.1.5",
-    "vitepress-for-component": "^0.14.2",
+    "vitepress-for-component": "^0.14.4",
     "vue": "^3.0.1",
     "whatwg-fetch": "^3.5.0"
   },

diff --git a/src/useFullscreen/index.en-US.md b/src/useFullscreen/index.en-US.md
@@ -37,10 +37,10 @@ const [isFullscreen, { setFull, exitFull, toggleFull }] = useFullScreen(target,
 
 ### Params
 
-| Property | Description               | Type                                                             | Default |
-| -------- | ------------------------- | ---------------------------------------------------------------- | ------- |
-| target   | DOM element or Ref Object | `HTMLElement` \| `() => HTMLElement` \| `React.MutableRefObject` | -       |
-| options  | setting(optional)         | `Options`                                                        | -       |
+| Property | Description               | Type                                 | Default |
+| -------- | ------------------------- | ------------------------------------ | ------- |
+| target   | DOM element or Ref Object | `HTMLElement` \| `() => HTMLElement` |
+| options  | setting(optional)         | `Options`                            | -       |
 
 ### Options
 

diff --git a/src/useFullscreen/index.zh-CN.md b/src/useFullscreen/index.zh-CN.md
@@ -15,16 +15,14 @@ Api 与[ahooks](https://ahooks.js.org/zh-CN/hooks/dom/use-fullscreen)一致。
 
 ### 基本用法
 
-<demo
-  src="./demo/demo1.vue"
+<demo src="./demo/demo1.vue"
   language="vue"
   desc="使用 ref 设置需要全屏的元素。">
 </demo>
 
 ### 传入目标元素
 
-<demo
-  src="./demo/demo2.vue"
+<demo src="./demo/demo2.vue"
   language="vue"
   desc="传入一个元素。">
 </demo>
@@ -37,10 +35,10 @@ const [isFullscreen, { setFull, exitFull, toggleFull }] = useFullScreen(target,
 
 ### Params
 
-| 参数    | 说明                  | 类型                                                             | 默认值 |
-| ------- | --------------------- | ---------------------------------------------------------------- | ------ |
-| target  | DOM 节点或者 Ref 对象 | `HTMLElement` \| `() => HTMLElement` \| `React.MutableRefObject` | -      |
-| options | 设置(可选)            | `Options`                                                        | -      |
+| 参数    | 说明                  | 类型                                 | 默认值 |
+| ------- | --------------------- | ------------------------------------ | ------ |
+| target  | DOM 节点或者 Ref 对象 | `HTMLElement` \| `() => HTMLElement` |
+| options | 设置(可选)            | `Options`                            | -      |
 
 ### Options
 

diff --git a/yarn.lock b/yarn.lock
@@ -7581,10 +7581,10 @@ vite@^2.0.1:
   optionalDependencies:
     fsevents "~2.3.1"
 
-vitepress-for-component@^0.14.2:
-  version "0.14.2"
-  resolved "https://registry.yarnpkg.com/vitepress-for-component/-/vitepress-for-component-0.14.2.tgz#844615c4a300b1c1632fdd2a6601ba5df72baf55"
-  integrity sha512-lNd9ErmaRYaSVWiz01NN9/+A168LQkfx0GagujCEa/zXAXAbsrzKQ+Vfu+89ib6B9JVUGCmxbq1427KSUu4YGg==
+vitepress-for-component@^0.14.4:
+  version "0.14.4"
+  resolved "https://registry.yarnpkg.com/vitepress-for-component/-/vitepress-for-component-0.14.4.tgz#6dee452d2740464847976bf5026e1415f2a7beee"
+  integrity sha512-k+o12vEMmERp4UwOwEjyIuzuXI6Kqql/5xZn5lyjg3ODQI8CyMyuRjd+7XUISUOI/CQx9GCasmQ9O7RCeDml6g==
   dependencies:
     "@docsearch/css" "^1.0.0-alpha.28"
     "@docsearch/js" "^1.0.0-alpha.28"