指南

以下是 VueUse 函数的指南。您也可以将其作为编写自己的组合式函数或应用程序的参考。

您还可以找到这些设计决策的一些原因，以及使用 Anthony Fu 关于 VueUse 的演讲编写组合式函数的一些技巧

• 可组合的 Vue - 在 VueDay 2021
• 可组合的 Vue - 在 VueConf China 2021 (中文)

通用

• 从 "vue" 导入所有 Vue API
• 尽可能使用 ref 而不是 reactive
• 尽可能使用选项对象作为参数，以便更灵活地进行未来扩展。
• 尽可能优先使用 shallowRef 而不是 ref
• 在需要深度响应性的情况下，优先使用显式命名的 deepRef 而不是 ref
• 当使用像 window 这样的全局变量时，使用 configurableWindow (等) 以便在使用多窗口、测试模拟和 SSR 时具有灵活性。
• 当涉及到浏览器尚未广泛实现的 Web API 时，也输出 isSupported 标志
• 当在内部使用 watch 或 watchEffect 时，也尽可能使 immediate 和 flush 选项可配置
• 使用 tryOnUnmounted 来优雅地清除副作用
• 避免使用控制台日志
• 当函数是异步的时，返回一个 PromiseLike

另请阅读：最佳实践

ShallowRef

当包装大量数据时，使用 shallowRef 而不是 ref。

export function useFetch<T>(url: MaybeRefOrGetter<string>) {
  // use `shallowRef` to prevent deep reactivity
  const data = shallowRef<T | undefined>()
  const error = shallowRef<Error | undefined>()

  fetch(toValue(url))
    .then(r => r.json())
    .then(r => data.value = r)
    .catch(e => error.value = e)

  /* ... */
}

可配置全局变量

当使用像 window 或 document 这样的全局变量时，在选项接口中支持 configurableWindow 或 configurableDocument，以便在多窗口、测试模拟和 SSR 等场景中使函数具有灵活性。

了解更多关于实现的细节：_configurable.ts

import type { ConfigurableWindow } from '../_configurable'
import { defaultWindow } from '../_configurable'
import { useEventListener } from '../useEventListener'

export function useActiveElement<T extends HTMLElement>(
  options: ConfigurableWindow = {},
) {
  const {
    // defaultWindow = isClient ? window : undefined
    window = defaultWindow,
  } = options

  let el: T

  // skip when in Node.js environment (SSR)
  if (window) {
    useEventListener(window, 'blur', () => {
      el = window?.document.activeElement
    }, true)
  }

  /* ... */
}

使用示例

// in iframe and bind to the parent window
useActiveElement({ window: window.parent })

监听选项

当在内部使用 watch 或 watchEffect 时，也尽可能使 immediate 和 flush 选项可配置。例如 watchDebounced

import type { WatchOptions } from 'vue'

// extend the watch options
export interface WatchDebouncedOptions extends WatchOptions {
  debounce?: number
}

export function watchDebounced(
  source: any,
  cb: any,
  options: WatchDebouncedOptions = {},
): WatchStopHandle {
  return watch(
    source,
    () => { /* ... */ },
    options, // pass watch options
  )
}

控制

我们使用 controls 选项，允许用户在简单使用时使用单个返回值的函数，同时能够在需要时拥有更多控制和灵活性。阅读更多：#362。

何时提供 controls 选项

• 该函数更常用于单个 ref 或
• 示例：useTimestamp, useInterval,

// common usage
const timestamp = useTimestamp()

// more controls for flexibility
const { timestamp, pause, resume } = useTimestamp({ controls: true })

参考 useTimestamp 的源代码，了解正确的 TypeScript 支持的实现。

何时不提供 controls 选项

• 该函数更常用于多个返回值
• 示例：useRafFn, useRefHistory,

const { pause, resume } = useRafFn(() => {})

isSupported 标志

当涉及到浏览器尚未广泛实现的 Web API 时，也输出 isSupported 标志。

例如 useShare

export function useShare(
  shareOptions: MaybeRef<ShareOptions> = {},
  options: ConfigurableNavigator = {},
) {
  const { navigator = defaultNavigator } = options
  const isSupported = useSupported(() => navigator && 'canShare' in navigator)

  const share = async (overrideOptions) => {
    if (isSupported.value) {
      /* ...implementation */
    }
  }

  return {
    isSupported,
    share,
  }
}

异步组合式函数

当一个组合式函数是异步的，例如 useFetch，从组合式函数返回一个 PromiseLike 对象是一个好主意，这样用户就能够等待该函数。这在 Vue 的 <Suspense> api 的情况下尤其有用。

• 使用 ref 来确定函数何时应该解析，例如 isFinished
• 将返回状态存储在一个变量中，因为它必须返回两次，一次在返回中，一次在 promise 中。
• 返回类型应该是返回类型和 PromiseLike 之间的交叉类型，例如 UseFetchReturn & PromiseLike<UseFetchReturn>

export function useFetch<T>(url: MaybeRefOrGetter<string>): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> {
  const data = shallowRef<T | undefined>()
  const error = shallowRef<Error | undefined>()
  const isFinished = ref(false)

  fetch(toValue(url))
    .then(r => r.json())
    .then(r => data.value = r)
    .catch(e => error.value = e)
    .finally(() => isFinished.value = true)

  // Store the return state in a variable
  const state: UseFetchReturn<T> = {
    data,
    error,
    isFinished,
  }

  return {
    ...state,
    // Adding `then` to an object allows it to be awaited.
    then(onFulfilled, onRejected) {
      return new Promise<UseFetchReturn<T>>((resolve, reject) => {
        until(isFinished)
          .toBeTruthy()
          .then(() => resolve(state))
          .then(() => reject(state))
      }).then(onFulfilled, onRejected)
    },
  }
}

无渲染组件

• 使用渲染函数而不是 Vue SFC
• 将 props 包裹在 reactive 中，以便轻松地将它们作为 props 传递给插槽
• 优先使用函数选项作为 prop 类型，而不是自己重新创建它们
• 仅当函数需要绑定到的目标时，才将插槽包裹在 HTML 元素中

import type { MouseOptions } from '@vueuse/core'
import { useMouse } from '@vueuse/core'
import { defineComponent, reactive } from 'vue'

export const UseMouse = defineComponent<MouseOptions>({
  name: 'UseMouse',
  props: ['touch', 'resetOnTouchEnds', 'initialValue'] as unknown as undefined,
  setup(props, { slots }) {
    const data = reactive(useMouse(props))

    return () => {
      if (slots.default)
        return slots.default(data)
    }
  },
})

有时一个函数可能具有多个参数，在这种情况下，您可能需要创建一个新的接口来将所有接口合并到组件 props 的单个接口中。

import type { TimeAgoOptions } from '@vueuse/core'
import { useTimeAgo } from '@vueuse/core'

interface UseTimeAgoComponentOptions extends Omit<TimeAgoOptions<true>, 'controls'> {
  time: MaybeRef<Date | number | string>
}

export const UseTimeAgo = defineComponent<UseTimeAgoComponentOptions>({ /* ... */ })