SVG framework function: observe

This tutorial is part of Iconify SVG Framework functions tutorial.

Function observe() tells SVG framework to watch HTML element for icon placeholders, so SVG framework could find them and replace with <svg>.

SVG framework automatically watches document.body, so no need to call this function for documet.body.

When to use this function:

  • If you have removed observer for document.body using stopObserving(document.body) (you should not do this, use pauseObserver() instead to pause observer instead of removing observer).
  • If you need to observe element that is not part of document.body, such as Shadow DOM.

Usage

Function has the following parameter:

  • root, HTMLElement. Element to observe.

Example

// Create element.
const node = document.createElement('div');

// Tell SVG framework to watch element.
Iconify.observe(node);

// Add icon 1 second later - it will be replaced with <svg>
setTimeout(() => {
   node.innerHTML =
       'Home icon: <span class="iconify" data-icon="mdi:home"></span>';
}, 1000);
// Create element, start watching it.
function createNode() {
   let clicked = false;

   // Create element, set content.
   const node = document.createElement('a');
   node.innerHTML =
       '<span class="iconify" data-icon="carbon:circle-dash"></span>';

   // Change icon on click.
   node.addEventListener('click', () => {
       clicked = !clicked;
       node
           .querySelector('.iconify')
           .setAttribute(
               'data-icon',
               clicked ? 'carbon:circle-filled' : 'carbon:circle-dash'
           );
   });

   // Observe changes.
   // This is not needed if you are adding element to document.body because document.body is already
   // automatically watched. Use this if element is part of Shadow DOM or some other custom elements tree.
   Iconify.observe(node);

   return node;
}

// Stop watching element.
// Always stop observing element if you no longer need it!
// SVG framework doesn't know if you still need an element.
function removeNode(node) {
   Iconify.stopObserving(node);
}

Notes

  • Icon placeholders are not replaced immediately. It might happen on the next tick or when icon data has been retrieved from API. Do not expect HTML to include <svg> tags right after you change element's content. If you want to find an icon in your root element, search by class name "iconify" or by attribute data-icon, not by tag. If you want to have full control over rendering, see renderSVG(), renderHTML() and loadIcons().
  • When you start observing a custom element, it is scanned for placeholders. No need to call scan(), it is done automatically.