basic-interactions v0.2.1

This is README for basic-interactions

Simple interactions library are willing to unify and simplify the approach of developing routine interaction tasks as toggle classes for HTML DOM elements.

The main approach is to use one global Class that can obtain and process all actions based on the custom data attributes provided for each element.

The main goal is not develop each time on the new project the common JS code and use instead only HTML markup to add basic interactivity.

Installation

Install basic-interactions package:

npm install basic-interactions

Initialize basic event listeners to use Class functionality

import BasicInteractions from 'basic-interactions';

window.addEventListener('load', () => {
  // create class instance
  const bi = new BasicInteractions();
  // init default event listeners
  bi.init();
});

In order to init global event listeners with some additional functionality, you can manually add all needed event listeners.

init() method has the following code, that you can replicate with desired modifications:

//interact on load
bi.handleAutoInteraction();

// add global listeners for you app
document.addEventListener('click', ({ target }) => {
  bi.handleInteraction(target);
});

window.addEventListener('resize', () => {
  bi.debounce(() => {
    if (bi.resets?.length > 0) {
      bi.handleResets('resize');
    }
  });
});

window.addEventListener('keydown', (e) => {
  if (e.key === 'Escape') bi.handleResets('escape');
});

How to use it?

After the installation process and setup of needed EventListeners, all you need is just use prepared data attributes to add interactivity into your project

Data Attributes

Common usage

Toggle classes on click:

<button data-toggle="some classes goes here"></button>

Toggle classes on click and load:

<button data-toggle="some classes goes here" data-on-load></button>

Toggle classes with reset options (escape and resize):

<button data-toggle="some classes goes here" data-rest="escape resize"></button>

Toggle classes for all specific targets:

<button
  data-toggle-target-class="some classes goes here"
  data-toggle-target=".target"
></button>

Add or Remove classes for specific target or targets:

<button
  data-toggle-target-class="some classes goes here"
  data-toggle-target-action="add"
  data-toggle-target="#target-id"
></button>
<button
  data-toggle-target-class="some classes goes here"
  data-toggle-target-action="remove"
  data-toggle-target=".another-targets"
></button>

Toggle classes for specific target and event target:

<button
  data-toggle="some classes goes here"
  data-toggle-target-class="other classes"
  data-toggle-target="#target-id"
></button>

Toggle classes and body scroll:

<button
  data-toggle="some classes goes here"
  data-toggle-scroll
  data-rest="escape resize"
></button>

Toggle classes for group of element where only one element should be active (with toggled classes):

<div data-group-reset>
  <button data-toggle="some classes goes here"></button>
  <button data-toggle="some classes goes here"></button>
  <button data-toggle="some classes goes here"></button>
</div>

Toggle/Add/Remove data attributes to HTML markup

<button
  data-toggle="className"
  data-attr="data-test"
  data-attr-value="test value"
></button>
<button
  data-toggle="className"
  data-attr="data-test"
  data-attr-value="test value"
  data-attr-action="add"
></button>
<button
  data-toggle="className"
  data-attr="data-test"
  data-attr-action="remove"
></button>

Advanced Usage / adding extra functionality

Below is an example on how to track DOM mutations for adding additional functionality.

Example based on adding and removing custom data attribute: 'data-src'.

window.addEventListener('load', () => {
  const observer = new MutationObserver((mutationList) => {
    mutationList.forEach((mutation) => {
      if (mutation.attributeName === 'data-src') {
        if (mutation.target.hasAttribute('data-src')) {
          // mutation on add atr
          // your code goes here...
        } else {
          // mutation on remove atr
          // your code goes here...
        }
      }
    });
  });
  observer.observe(document.querySelector('#modal'), {
    attributes: true,
    attributeFilter: ['data-src'],
  });
});

More info about usage of Mutation Observer you can find on MDN.