|
1 | | -# v3hook [](https://travis-ci.com/lmhcoding/v3hook) |
| 1 | +# vhook |
2 | 2 |
|
3 | 3 | Collection of Vue Composition Functions |
4 | 4 |
|
5 | 5 | ## Install |
6 | 6 |
|
7 | 7 | ```bash |
8 | | -npm i v3hook |
| 8 | +npm i vhook |
9 | 9 | ``` |
10 | 10 |
|
11 | 11 |
|
12 | 12 |
|
13 | 13 |
|
14 | 14 |
|
15 | 15 | - State |
16 | | - - [``useTitle``](https://lmhcoding.github.io/v3hook/state/useTitle.html) —— 用于设置页面的标签页标题 |
17 | | - - [``useToggle``](https://lmhcoding.github.io/v3hook/state/useToggle.html) —— 用于在两个状态之间切换 |
18 | | - - [``useBoolean``](https://lmhcoding.github.io/v3hook/state/useBoolean.html) —— 用于管理 ``Boolean`` 状态的 ``Hook`` |
19 | | - - [``useHash``](https://lmhcoding.github.io/v3hook/state/useHash.html) —— 追踪 ``location.hash`` 的变化 |
20 | | - - [``useHistory``](https://lmhcoding.github.io/v3hook/state/useHistory.html) —— 追踪 ``history`` 的变化 |
| 16 | + - [``useTitle``](https://lmhcoding.github.io/vhook/state/useTitle.html) —— 用于设置页面的标签页标题 |
| 17 | + - [``useToggle``](https://lmhcoding.github.io/vhook/state/useToggle.html) —— 用于在两个状态之间切换 |
| 18 | + - [``useBoolean``](https://lmhcoding.github.io/vhook/state/useBoolean.html) —— 用于管理 ``Boolean`` 状态的 ``Hook`` |
| 19 | + - [``useHash``](https://lmhcoding.github.io/vhook/state/useHash.html) —— 追踪 ``location.hash`` 的变化 |
| 20 | + - [``useHistory``](https://lmhcoding.github.io/vhook/state/useHistory.html) —— 追踪 ``history`` 的变化 |
21 | 21 | - DOM |
22 | | - - [``useEvent``](https://lmhcoding.github.io/v3hook/dom/useEvent.html) / [``useEventRef``](https://lmhcoding.github.io/v3hook/dom/useEventRef.html) —— 用于监听事件的 ``Hook`` |
| 22 | + - [``useEvent``](https://lmhcoding.github.io/vhook/dom/useEvent.html) / [``useEventRef``](https://lmhcoding.github.io/vhook/dom/useEventRef.html) —— 用于监听事件的 ``Hook`` |
23 | 23 | - Lifecycles |
24 | | - - [``useLifecycles``](https://lmhcoding.github.io/v3hook/lifecycles/useLifecycles.html) —— 同时使用 ``onMounted`` 和 ``onUnmounted`` 的 ``Hook`` |
| 24 | + - [``useLifecycles``](https://lmhcoding.github.io/vhook/lifecycles/useLifecycles.html) —— 同时使用 ``onMounted`` 和 ``onUnmounted`` 的 ``Hook`` |
25 | 25 | - SideEffects |
26 | | - - [``useDebounce``](https://lmhcoding.github.io/v3hook/effects/useDebounce.html) —— 带防抖功能的状态 |
27 | | - - [``useDebounceFn``](https://lmhcoding.github.io/v3hook/effects/useDebounceFn.html) —— 生成带防抖功能的函数 |
28 | | - - [``useInterval``](https://lmhcoding.github.io/v3hook/effects/useInterval.html) —— 对 ``setInterval`` 的简单封装 |
29 | | - - [``useTimeout``](https://lmhcoding.github.io/v3hook/effects/useTimeout.html) —— 用于在一段时间后更新值 |
30 | | - - [``useTimeoutFn``](https://lmhcoding.github.io/v3hook/effects/useTimeoutFn.html) —— 用于在一段时间后执行回调 |
| 26 | + - [``useDebounce``](https://lmhcoding.github.io/vhook/effects/useDebounce.html) —— 带防抖功能的状态 |
| 27 | + - [``useDebounceFn``](https://lmhcoding.github.io/vhook/effects/useDebounceFn.html) —— 生成带防抖功能的函数 |
| 28 | + - [``useInterval``](https://lmhcoding.github.io/vhook/effects/useInterval.html) —— 对 ``setInterval`` 的简单封装 |
| 29 | + - [``useTimeout``](https://lmhcoding.github.io/vhook/effects/useTimeout.html) —— 用于在一段时间后更新值 |
| 30 | + - [``useTimeoutFn``](https://lmhcoding.github.io/vhook/effects/useTimeoutFn.html) —— 用于在一段时间后执行回调 |
31 | 31 | - Storage |
32 | | - - [``useLocalStorage``](https://lmhcoding.github.io/v3hook/storage/useLocalStorage.html) —— 具备响应式功能的 ``localStorage`` 状态 |
33 | | - - [``useSessionStorage``](https://lmhcoding.github.io/v3hook/storage/useSessionStorage.html) —— 具备响应式功能的 ``sessionStorage`` 状态 |
34 | | - - [``useStorage``](https://lmhcoding.github.io/v3hook/storage/useStorage.html) —— 提供具备响应式的 ``localStorage`` 或 ``sessionStorage`` 状态 |
| 32 | + - [``useLocalStorage``](https://lmhcoding.github.io/vhook/storage/useLocalStorage.html) —— 具备响应式功能的 ``localStorage`` 状态 |
| 33 | + - [``useSessionStorage``](https://lmhcoding.github.io/vhook/storage/useSessionStorage.html) —— 具备响应式功能的 ``sessionStorage`` 状态 |
| 34 | + - [``useStorage``](https://lmhcoding.github.io/vhook/storage/useStorage.html) —— 提供具备响应式的 ``localStorage`` 或 ``sessionStorage`` 状态 |
35 | 35 | - Sensors |
36 | | - - [``useResize``](https://lmhcoding.github.io/v3hook/sensors/useResize.html) —— 追踪 ``window`` 的大小 |
37 | | - - [``useScroll``](https://lmhcoding.github.io/v3hook/sensors/useScroll.html) / [``useScrollRef``](https://lmhcoding.github.io/v3hook/sensors/useScrollRef.html) —— 追踪特定 ``DOM`` 节点的滚动位置 |
38 | | - - [``useWindowScroll``](https://lmhcoding.github.io/v3hook/sensors/useWindowScroll.html) —— 追踪 ``window`` 滚动的位置 |
| 36 | + - [``useResize``](https://lmhcoding.github.io/vhook/sensors/useResize.html) —— 追踪 ``window`` 的大小 |
| 37 | + - [``useScroll``](https://lmhcoding.github.io/vhook/sensors/useScroll.html) / [``useScrollRef``](https://lmhcoding.github.io/vhook/sensors/useScrollRef.html) —— 追踪特定 ``DOM`` 节点的滚动位置 |
| 38 | + - [``useWindowScroll``](https://lmhcoding.github.io/vhook/sensors/useWindowScroll.html) —— 追踪 ``window`` 滚动的位置 |
0 commit comments