指南

🌐 Guidelines

以下是 VueUse 函数的指南。你也可以将它们作为编写自己的可组合函数或应用的参考。

🌐 Here are the guidelines for VueUse functions. You could also take them as a reference for authoring your own composable functions or apps.

你还可以通过 Anthony Fu 关于 VueUse 的演讲，了解这些设计决策的一些原因，以及编写可组合函数的一些技巧：

🌐 You can also find some reasons for those design decisions and also some tips for writing composable functions with Anthony Fu's talk about VueUse:

• 可组合的 Vue - 在 VueDay 2021
• 可组合的 Vue - 在 VueConf China 2021（中文）

通用

🌐 General

• 从 "vue" 导入所有 Vue API
• 尽可能使用 ref 替代 reactive
• 尽可能使用选项对象作为参数，以便将来的扩展更加灵活。
• 尽可能优先使用 shallowRef 而不是 ref
• 在深度反应情况下，优先使用明确命名的 deepRef 而不是 ref
• 在使用像 window 这样的全局变量时，使用 configurableWindow（等等）可以在处理多窗口、测试模拟和服务端渲染时更加灵活。
• 当涉及尚未被浏览器广泛支持的 Web API 时，也会输出 isSupported 标志
• 在内部使用 watch 或 watchEffect 时，也应尽可能使 immediate 和 flush 选项可配置
• 使用 tryOnScopeDispose 优雅地清除副作用
• 避免使用控制台日志
• 当函数异步时，返回一个 PromiseLike

另请参阅：最佳实践

🌐 Read also: Best Practice

ShallowRef

在封装大量数据时，使用 shallowRef 替代 ref。

🌐 Use shallowRef instead of ref when wrapping large amounts of data.

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)

  /* ... */
}

可配置的全局变量

🌐 Configurable Globals

在使用类似 window 或 document 的全局变量时，在选项接口中支持 configurableWindow 或 configurableDocument 可以使函数在多窗口、测试模拟和服务端渲染等场景下更加灵活。

🌐 When using global variables like window or document, support configurableWindow or configurableDocument in the options interface to make the function flexible when for scenarios like multi-windows, testing mocks, and SSR.

了解更多关于实现的信息：_configurable.ts

🌐 Learn more about the implementation: _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)
  }

  /* ... */
}

使用示例：

🌐 Usage example:

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

监视选项

🌐 Watch Options

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

🌐 When using watch or watchEffect internally, also make the immediate and flush options configurable whenever possible. For example 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 = {},
): WatchHandle {
  return watch(
    source,
    () => { /* ... */ },
    options, // pass watch options
  )
}

控制

🌐 Controls

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

🌐 We use the controls option allowing users to use functions with a single return for simple usages, while being able to have more controls and flexibility when needed. Read more: #362.

何时提供 controls 选项

🌐 When to provide a controls option

• 该函数更常与单个 ref 一起使用，或
• 示例：useTimestamp，useInterval，

// common usage
const timestamp = useTimestamp()

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

请参考 useTimestamp 的源代码以了解 TypeScript 的正确实现方式。

🌐 Refer to useTimestamp's source code for the implementation of proper TypeScript support.

何时不提供controls选项

🌐 When NOT to provide a controls option

• 该函数更常用的是多次返回
• 示例：useRafFn，useRefHistory，

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

isSupported 标志

🌐 isSupported Flag

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

🌐 When involved with Web APIs that are not yet implemented by the browser widely, also outputs isSupported flag.

例如 useShare：

🌐 For example 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,
  }
}

异步可组合项

🌐 Asynchronous Composables

当一个组合函数是异步的，比如 useFetch，最好从该组合函数返回一个类似 Promise 的对象，以便用户能够等待该函数完成。这在使用 Vue 的 <Suspense> 接口时尤其有用。

🌐 When a composable is asynchronous, like useFetch, it is a good idea to return a PromiseLike object from the composable so the user is able to await the function. This is especially useful in the case of Vue's <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)
    },
  }
}

无渲染组件

🌐 Renderless Components

• 使用渲染函数代替 Vue SFC
• 将属性封装在 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)
    }
  },
})

有时一个函数可能有多个参数，在这种情况下，你可能需要创建一个新的接口，将所有接口合并成一个用于组件属性的单一接口。

🌐 Sometimes a function may have multiple parameters, in that case, you maybe need to create a new interface to merge all the interfaces into a single interface for the component 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>({ /* ... */ })