README
Widgets Utils
Collection of useful functions for AB Tasty Widgets.
Installation
Inside your Widget folder, install the widget-utils
library:
npm install @abtasty/widget-utils
Note: you can also use yarn instead of npm: yarn add @abtasty/widget-utils
Usage
With Webpack or Rollup.js:
import { waitForElement, isAffected } from '@abtasty/widget-utils'
const waitForBody = waitForElement('#section', section => {
section.insertAdjacentHTML('beforeend', '<p>New paragraph at the end of that section.</p>');
});
setTimeout(() => {
if (!isAffected()) {
waitForBody.clear();
}
}, 10000);
Link this local project to a local widget project
Using NPM Link (recommended)
When you have installed and build your locally project :
- run in a terminal :
npm link
in yourwidget-utils
folder - in your widget local folder you want to test this project, run in a terminal :
npm link @abtasty/widget-utils
- build your widget project, then build
editor
project.
Using symlink
First, install your widget-utils
, copy the path of the project.
Then, In your local widget project :
- after a
npm install
, delete the folder/node_modules/@abtasty/widget-utils
- with your terminal, navigate to the folder
/node_modules/@abtasty/
- run the bash command :
ln -s {your path to widget-utils project folder} widget-utils
A symlink has been created in your widget project, with the folder: /node_modules/@abtasty/widget-utils