跳到内容

useMutationObserver

分类
导出大小
564 B
最后更改
5 天前

监视对 DOM 树所做的更改。MutationObserver MDN

演示

用法

ts
import { useMutationObserver } from '@vueuse/core'
import { ref, useTemplateRef } from 'vue'

export default {
  setup() {
    const el = useTemplateRef('el')
    const messages = ref([])

    useMutationObserver(el, (mutations) => {
      if (mutations[0])
        messages.value.push(mutations[0].attributeName)
    }, {
      attributes: true,
    })

    return {
      el,
      messages,
    }
  },
}

类型声明

typescript
export interface UseMutationObserverOptions
  extends MutationObserverInit,
    ConfigurableWindow {}
/**
 * Watch for changes being made to the DOM tree.
 *
 * @see https://vueuse.org.cn/useMutationObserver
 * @see https://mdn.org.cn/en-US/docs/Web/API/MutationObserver MutationObserver MDN
 * @param target
 * @param callback
 * @param options
 */
export declare function useMutationObserver(
  target:
    | MaybeComputedElementRef
    | MaybeComputedElementRef[]
    | MaybeRefOrGetter<MaybeElement[]>,
  callback: MutationCallback,
  options?: UseMutationObserverOptions,
): {
  isSupported: ComputedRef<boolean>
  stop: () => void
  takeRecords: () => MutationRecord[] | undefined
}
export type UseMutationObserverReturn = ReturnType<typeof useMutationObserver>

源码

源码演示文档

贡献者

Anthony Fu
IlyaL
Anthony Fu
丶远方
Jelf
我想静静
OrbisK
Pim
jdm1219
chirokas
huodoushigemi
AaronBeaudoin
laozei
karma
Shinigami
Alex Kozack
Antério Vieira
zhong666

更新日志

v12.8.0 于 2025/3/5
7432f - feat(types): 弃用 MaybeRefMaybeRefOrGetter,支持 Vue 原生 (#4636)
v12.3.0 于 2025/1/2
021d0 - feat(toArray): 新增实用函数 (#4432)
59f75 - feat(toValue): 弃用 @vueuse/shared 中的 toValue,支持 Vue 原生
v12.0.0-beta.1 于 2024/11/21
0a9ed - feat!: 移除 Vue 2 支持,优化 bundles 并清理代码 (#4349)
v11.0.0-beta.1 于 2024/6/12
489a9 - fix: 在清理之前停止监听 (#4037)
v10.8.0 于 2024/2/20
98fac - feat: 允许使用多个目标 (#3741)
v10.6.0 于 2023/11/9
f9136 - feat: 添加 takeRecords 函数 (#3480)
v10.5.0 于 2023/10/7
8167b - feat: 使用 MaybeComputedElementRef (#3430)

在 MIT 许可证下发布。