@abtasty/widget-utils

1.18.38 • Public • Published

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 :

  1. run in a terminal : npm link in your widget-utils folder
  2. in your widget local folder you want to test this project, run in a terminal : npm link @abtasty/widget-utils
  3. 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

Development

Generating fonts.js File

The fonts.js file in this repo is exposing the Google Fonts from ABTasty CDN (which is populated by this repo: https://gitlab.com/abtasty/turfu/common-fonts)

Any changes in the common-fonts repo must follow the font regeneration here.

To regenerate the fonts.js file,

  • run the following command in the root of this repo:
yarn run generateFonts
  • And commit the file
  • Create the merge request
  • Seek at least one approval from fellow frontend developers or nautilus team
  • Merge the MR

Releasing this repo

Once the MR is approved, follow the following steps:

  • Release this repo on npm with npm publish
  • Merge the repo

Readme

Keywords

none

Package Sidebar

Install

npm i @abtasty/widget-utils

Weekly Downloads

7

Version

1.18.38

License

none

Unpacked Size

1.09 MB

Total Files

3

Last publish

Collaborators

  • m.tuseeva
  • magomedcharto
  • romane.boireau
  • jeanszleper-abtasty
  • stepan-abtasty
  • pankajpatel_abtasty
  • tonykhaov-abtasty
  • mick_mikhail
  • tiwariamrita
  • mndiaye
  • jmeyer81
  • alexabt
  • gnicolas.abtasty
  • marijapetrov
  • merki230
  • theoletouze
  • monikap
  • cedric.vimont
  • tudor.abtasty
  • bricelof
  • igor.goncharenko
  • guillaume-abtasty
  • clement.bock.abtasty
  • amine.bouchebaba
  • romain.guillaume.abtasty.com
  • julien_niedzwiecki
  • balintfulop
  • mmurugan
  • alexey.nikonov
  • suleyman_kachkache
  • brendon.b
  • abtasty-user
  • florian_abtasty
  • j.u.p.iter
  • tcoppin_
  • jonathangranger
  • elias-abt
  • alexbinet
  • cquandalle
  • benoitdubus
  • jean-baptiste.agostin
  • simenbjerkeset
  • pierrevinarnick