JSPM

  • Created
  • Published
  • Downloads 869
  • Score
    100M100P100Q107370F
  • License MIT

A mutation observer based livequery replacement.

Package Exports

  • iripo

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (iripo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Iripo

A jquery livequery replacement, built with all the hearty goodness and performance of MutationObserver. Any change to the <html> element or any children (<head>, <body>, or child elements within those nodes) will trigger Iripo. Iripo will only run callback functions when matching elements have appeared or disappeared from the page, and only run when the browser is idle, so as to increase performance.

NOTE: Iripo will intentionally not run when text has been changed on the page, only when actual DOM nodes have been altered.

Usage

  1. Include iripo in your build npm install iripo or yarn add iripo.

  2. Run a callback function when a matching element is added to the page: (can use any native javascript selector)

    iripo.in('p.my-class', (element) => {
      console.log('my element', element);
    });

    By default all in callbacks will be run once the page is first loaded (when DOMContentLoaded fires), and then again when any new matching element is added to the page.

    If you want to ensure that a callback is run immediately (for example, to run a callback on a pre-existing element on the page) you can pass the processNow option to the in function like so:

    iripo.in(
      'p.my-class',
      (element) => {
        console.log('my element', element);
      },
      {
        processNow: true,
      }
    );

    This callback will immediately execute against any matching element, without waiting for any new elements to appear. It will also listen for new matching elements and run again once any new matching element is found.

  3. Run a callback function when a matching element is removed from the page: (can use any native javascript selector)

    iripo.out('button#some-id', (element) => {
      console.log('my element', element);
    });
  4. Pause all callback functions:

    iripo.pauseAll();

    or just pause a specific one by calling pause and passing in a specific selector:

    iripo.pause('button.my-class');
  5. Resume all callback functions:

    iripo.resumeAll();

    or just resume a specific one by calling resume and passing in a specific selector:

    iripo.resume('button');
  6. Clear a callback function to prevent it from ever running again:

    iripo.clear('button');

Options

By default Iripo will ignore any changes which take place in a page's <head>. You can easily change this to observe changes here as well by setting:

iripo.ignoreMutationsInHead = false;

What's up with the name "Iripo"?

My wife is from Zimbabwe, and the language spoken by most of the country is Shona. Depending on the context, the word iripo can mean "is it there?" or "there it is", which seemed like an appropriate name for a library that detects and reacts to something if it exists.