Skip to content

useMutationObserver ​

Category
Export Size
564 B
Last Changed
yesterday

Watch for changes being made to the DOM tree. MutationObserver MDN

Demo ​

Usage ​

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

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

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

    return {
      el,
      messages,
    }
  },
}

Type Declarations ​

typescript
export interface UseMutationObserverOptions
  extends MutationObserverInit,
    ConfigurableWindow {}
/**
 * Watch for changes being made to the DOM tree.
 *
 * @see https://vueuse.org/useMutationObserver
 * @see https://developer.mozilla.org/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>

Source ​

Source • Demo • Docs

Contributors ​

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

Changelog ​

Pending for release...
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
v12.0.0-beta.1 on 11/21/2024
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
v11.0.0-beta.1 on 6/12/2024
489a9 - fix: stop watching before cleaning up (#4037)
v10.8.0 on 2/20/2024
98fac - feat: allow multiple targets (#3741)
v10.6.0 on 11/9/2023
f9136 - feat: add takeRecords function (#3480)
v10.5.0 on 10/7/2023
8167b - feat: use MaybeComputedElementRef (#3430)

Released under the MIT License.