Skip to content

A utility that uses MutationObserver to execute callbacks when specified elements appear or change in the DOM.

License

Notifications You must be signed in to change notification settings

Space48/mutation-ready

Repository files navigation

mutation-ready

A lightweight utility for detecting and handling DOM mutations using MutationObserver.

This utility was inspired by the MutationObserver implementation from BigCommerce's Guide to Checkout Customisation.

Installation

npm install space48/mutation-ready

Usage

import { mutationReady } from 'mutation-ready';

// Wait for an element to appear in the DOM
mutationReady('.my-element', (element) => {
  // Do something with the element
  console.log('Element is ready:', element);
});

Features

  • Lightweight and dependency-free
  • TypeScript support
  • Uses MutationObserver for efficient DOM monitoring
  • Handles dynamic content loading
  • WebKit compatibility

API

mutationReady(selector: string, callback: (element: Element) => void): void

  • selector: CSS selector string to match elements
  • callback: Function to be called when matching elements are found
  • Each element will only trigger the callback once

Licence

MIT

About

A utility that uses MutationObserver to execute callbacks when specified elements appear or change in the DOM.

Resources

License

Stars

Watchers

Forks

Packages

No packages published