extendRef

Category

Reactivity

Export Size

207 B

Last Changed

3 hours ago

向 Ref 添加额外的属性。

用法

请注意，额外的属性在 Vue 的模板中不可访问。

import { extendRef } from '@vueuse/core'
import { shallowRef } from 'vue'

const myRef = shallowRef('content')

const extended = extendRef(myRef, { foo: 'extra data' })

extended.value === 'content'
extended.foo === 'extra data'

Refs 将被解包并保持响应式

const myRef = shallowRef('content')
const extraRef = shallowRef('extra')

const extended = extendRef(myRef, { extra: extraRef })

extended.value === 'content'
extended.extra === 'extra'

extended.extra = 'new data' // 将触发更新
extraRef.value === 'new data'

Type Declarations

export interface ExtendRefOptions<Unwrap extends boolean = boolean> {
  /**
   * 扩展属性是否可枚举
   *
   * @default false
   */
  enumerable?: boolean
  /**
   * 是否对 Ref 类型的属性进行解包
   *
   * @default true
   */
  unwrap?: Unwrap
}
/**
 * 重载 1: Unwrap 设置为 false
 */
export declare function extendRef<
  R extends Ref<any>,
  Extend extends object,
  Options extends ExtendRefOptions<false>,
>(ref: R, extend: Extend, options?: Options): ShallowUnwrapRef<Extend> & R
/**
 * 重载 2: Unwrap 未设置或设置为 true
 */
export declare function extendRef<
  R extends Ref<any>,
  Extend extends object,
  Options extends ExtendRefOptions,
>(ref: R, extend: Extend, options?: Options): Extend & R

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes