Étiquette : custom

[Webpack Encore] Intégration d’UIkit v3 dans un projet Symfony pour un bundle à la carte

27/04/2021 / admin

Méthode préférée de création d’un bundle des composants du framework front-end UIkit v3 avec Webpack

Testé fonctionnel UIkit v3.6.19!
Voir aussi: la méthode la plus simple, mais extrêmement limitée en terme de choix des composants qu’on souhaite importer (embarque tous les composants JS du core, embarque les styles d’absolument tous les composants).

Suite à différents tests de génération d’un bundle entièrement à la carte des composants d’UIkit v3 que j’ai effectué et à quelques soucis rencontrés avec l’affichage des icônes, je me suis rendu à l’évidence que le framework open-source développé par YOOTheme n’allait pas pouvoir être intégré à mon projet Symfony dans les règles de l’art.

Pour pouvoir sélectionner à la carte les composants et les icônes qui doivent figurer dans notre bundle (et surtout: retirer tous ceux qui ne vont pas servir!!!) tout en consignant les informations sur notre sélection directement dans le Git de notre projet, nous allons notamment devoir:

Créer un dossier mirroir des sources d’UIkit (dossier ./node_modules/uikit/*) dans le dossier qui contient le code spécifique à notre projet (dossier ./assets/uikit/* dans mon cas).
Commenter tous les composants dont nous n’aurons pas besoin pour notre build custom dans les fichiers assets/uikit/src/scss/theme/_import.scss et assets/uikit/src/scss/components/_import.scss (mirroirs de ceux du dossier source ./node_modules/uikit/src/scss/*).
Commenter tous les composants dont nous n’aurons pas besoin pour notre build custom dans les fichiers assets/uikit/src/js/core/index.js et assets/uikit/src/js/components/index.js (mirroirs de ceux du dossier source ./node_modules/uikit/src/js/*).
Consigner notre sélection d’icônes dans des dossiers mirroirs de ceux du dossier source ./node_modules/uikit/src/images/*
Exécuter un script bash qui va s’occuper de:
- Remplacer les fichiers source de ./node_modules/uikit/* par leurs versions mirroirs consignées dans ./assets/uikit/* (et ajouter les nouveaux fichiers si il y en a).
- Lancer, depuis ./node_modules/uikit, les commandes de build fournies dans les sources d’UIkit pour notre sélection de composants et d’icônes.
- Lancer, depuis la racine du projet Symfony, la commande Webpack de build des sources SCSS, JS et icônes de notre projet (yarn encore dev).

Cette technique s’inspire du concept de fork, à la différence qu’ici nous n’aurons pas à maintenir un fork à chaque montée de version d’UIkit (un nouveau tag tous les 15 jours au moment où j’écris ces lignes).
Ici, les modifications relatives aux sources d’UIkit sont également versionnées directement dans les sources de notre projet custom alors qu’avec un fork doit avoir par définition son propre dépôt (donc un seul repository à gérer au lieu de deux).

Il s’agit de générer de nouvelles sources « dist » d’UIkit, taillées sur-mesure sur la base de notre propre sélection de composants et d’icônes.

C’est la source présente dans le dossier ./node_modules/uikit/dist qui est importée par défaut par Webpack lorsque nous déclarons la ligne import UIkit from 'uikit'; dans le fichier assets/app.js.

Note: en procédant ainsi il devrait (je n’ai pas encore testé) être possible d’ajouter également vos propres composants, développés sur les bases d’UIkit, au build custom.

La configuration de Webpack

Fichier `webpack.config.js`

Dans la configuration de Webpack, ajouter l’alias pour le chemin vers les sources SCSS d’UIkit dans le dossier ./node_modules:

const Encore = require('@symfony/webpack-encore');
const path = require('path');

[...]

Encore
    .addAliases({
        // UIkit:
        '@uk-scss': path.resolve(__dirname, './node_modules/uikit/src/scss')
    })

[...]

    // enables Sass/SCSS support
    .enableSassLoader()

const Encore = require('@symfony/webpack-encore');

const path = require('path');

[...]

Encore

.addAliases({

// UIkit:

'@uk-scss': path.resolve(__dirname, './node_modules/uikit/src/scss')

})

[...]

// enables Sass/SCSS support

.enableSassLoader()

Le bundle à la carte des styles (format SCSS)

Note: le build standard des styles d’UIkit (format de sortie/dist CSS) a ceci de particulier qu’il est réalisé à partir des sources LESS. Le framework est bien fourni avec une version SCSS des styles, mais il s’agit juste d’une conversion faite à partir des sources LESS et générée via un script.

En d’autres termes, si nous souhaitons travailler à partir du format SCSS, le build pour cette partie devra être réalisé côté Webpack.

Fichier `assets/styles/app.scss`

/* Import your custom selection of UIkit components here: */
@import '_uikit-explicit-pieces';

1 2	/* Import your custom selection of UIkit components here: */ @import '_uikit-explicit-pieces';

Note: selon votre propre organisation de vos fichiers SCSS, l’import de _uikit-explicit-pieces.scss devrait intervenir très tôt (en tout premier?) dans votre chaîne d’imports.

Fichier `assets/styles/_uikit-explicit-pieces.scss`

Créer un fichier _uikit-explicit-pieces.scss qui suit à la lettre les directives de mise en place des styles relatifs au framework front-end UIkit.

L’alias @uk-scss déclaré plus haut dans le fichier webpack.config.js est utilisé ici comme racine du chemin vers les fichiers sources.

/*
 * Based on: UIkit v3.6.19
 * Source: https://github.com/uikit/uikit/tree/v3.6.19
 * Documentation: https://getuikit.com/docs/sass#how-to-build
 */

/* 1. Your custom variables and variable overwrites. */
//$global-link-color: tomato;

/* 2. Import default variables and available mixins. */
@import "@uk-scss/variables-theme.scss";
@import "@uk-scss/mixins-theme.scss";

/* 3. Your custom mixin overwrites. */
//@mixin hook-card() { color: tomato; }

/* 4. Import UIkit here: */
//@import "@uk-scss/theme/_import.scss"; // Comment if you don't want to include theme specific styles.
@import "@uk-scss/components/_import.scss";

* Based on: UIkit v3.6.19

* Source: https://github.com/uikit/uikit/tree/v3.6.19

* Documentation: https://getuikit.com/docs/sass#how-to-build

/* 1. Your custom variables and variable overwrites. */

//$global-link-color: tomato;

/* 2. Import default variables and available mixins. */

@import "@uk-scss/variables-theme.scss";

@import "@uk-scss/mixins-theme.scss";

/* 3. Your custom mixin overwrites. */

//@mixin hook-card() { color: tomato; }

/* 4. Import UIkit here: */

//@import "@uk-scss/theme/_import.scss"; // Comment if you don't want to include theme specific styles.

@import "@uk-scss/components/_import.scss";

Edit: l’utilisation de PurgeCSS avec Webpack rend le reste de la partie SCSS de cet article totalement OBSOLèTE!

Attention: les styles propres à la grille d’UIkit comportent des déclarations de type .uk-child-width-1-4@m. L’arobase n’étant pas présent dans la regex du defaultExtractor de PurgeCSS, il faudra faire comme moi dans le code ci-dessous et le rajouter si vous voulez éviter que les styles de la grille soient considérés comme non-utilisés et dégagés du bundle.

En effet, plus besoin d’éditer les fichiers _import.scss des sources d’UIkit pour commenter les composants dont nous n’avons pas besoin! PurgeCSS se charge de faire le boulot à notre place en scannant les chemins et fichiers que nous allons pointer dans sa configuration pour repérer les IDs et classes que nous utilisons et purement et simplement supprimer toutes les autres de notre bundle!

Voici un exemple à rajouter à la toute fin de votre fichier webpack.config.js:

    [...]

    // PurgeCSS
    // if (Encore.isProduction()) {
        Encore.addPlugin(new PurgeCssPlugin({
            paths: glob.sync([
                path.join(__dirname, './app/Resources/views/**/*.html.twig'),
                path.join(__dirname, './web/build/**/*.js')
            ]),
            defaultExtractor: (content) => {
                return content.match(/[\w-/:@]+(?<!:)/g) || [];
            }
        }));
    // }

;

// export the final config
module.exports = Encore.getWebpackConfig();

[...]

// PurgeCSS

// if (Encore.isProduction()) {

Encore.addPlugin(new PurgeCssPlugin({

paths: glob.sync([

path.join(__dirname, './app/Resources/views/**/*.html.twig'),

path.join(__dirname, './web/build/**/*.js')

]),

defaultExtractor: (content) => {

return content.match(/[\w-/:@]+(?<!:)/g) || [];

}

}));

// }

;

// export the final config

module.exports = Encore.getWebpackConfig();

Cette technique reste une suggestion, mais reconnaissez que c’est tout-de-même bien pratique!

Fichier `assets/uikit/src/scss/theme/_import.scss`

Ce fichier est, à la base, une copie conforme du fichier source https://github.com/uikit/uikit/blob/v3.6.19/src/scss/theme/_import.scss.

Commenter tous les composants dont vous n’aurez pas besoin pour votre build custom (où commenter carrément l’import de ce fichier dans assets/styles/_uikit-explicit-pieces.scss si vous pensez que rien ne va vous servir):

// Base
@import "variables.scss";
@import "base.scss";

// Elements
@import "link.scss";
@import "heading.scss";
@import "divider.scss";
@import "list.scss";
@import "description-list.scss";
@import "table.scss";
@import "icon.scss";
@import "form-range.scss";
@import "form.scss";
@import "button.scss";
@import "progress.scss";

// Layout
@import "section.scss";
@import "container.scss";
@import "tile.scss";
@import "card.scss";

// Common
@import "close.scss";
@import "spinner.scss";
@import "marker.scss";
@import "totop.scss";
@import "alert.scss";
@import "placeholder.scss";
@import "badge.scss";
@import "label.scss";
@import "overlay.scss";
@import "article.scss";
@import "comment.scss";
@import "search.scss";

// JavaScript
@import "accordion.scss";
@import "drop.scss";
@import "dropdown.scss";
@import "modal.scss";
@import "slider.scss";
@import "sticky.scss";
@import "offcanvas.scss";
@import "leader.scss";
@import "notification.scss";
@import "tooltip.scss";
@import "sortable.scss";
@import "countdown.scss";

@import "grid.scss";

// Navs
@import "nav.scss";
@import "navbar.scss";
@import "subnav.scss";
@import "breadcrumb.scss";
@import "pagination.scss";
@import "tab.scss";
@import "slidenav.scss";
@import "dotnav.scss";
@import "thumbnav.scss";
@import "iconnav.scss";

@import "lightbox.scss";

// Utilities
@import "animation.scss";
@import "width.scss";
@import "height.scss";
@import "text.scss";
@import "column.scss";
@import "background.scss";
@import "align.scss";
@import "utility.scss";
@import "margin.scss";
@import "padding.scss";
@import "position.scss";
@import "transition.scss";
@import "inverse.scss";

// Base

@import "variables.scss";

@import "base.scss";

// Elements

@import "link.scss";

@import "heading.scss";

@import "divider.scss";

@import "list.scss";

@import "description-list.scss";

@import "table.scss";

@import "icon.scss";

@import "form-range.scss";

@import "form.scss";

@import "button.scss";

@import "progress.scss";

// Layout

@import "section.scss";

@import "container.scss";

@import "tile.scss";

@import "card.scss";

// Common

@import "close.scss";

@import "spinner.scss";

@import "marker.scss";

@import "totop.scss";

@import "alert.scss";

@import "placeholder.scss";

@import "badge.scss";

@import "label.scss";

@import "overlay.scss";

@import "article.scss";

@import "comment.scss";

@import "search.scss";

// JavaScript

@import "accordion.scss";

@import "drop.scss";

@import "dropdown.scss";

@import "modal.scss";

@import "slider.scss";

@import "sticky.scss";

@import "offcanvas.scss";

@import "leader.scss";

@import "notification.scss";

@import "tooltip.scss";

@import "sortable.scss";

@import "countdown.scss";

@import "grid.scss";

// Navs

@import "nav.scss";

@import "navbar.scss";

@import "subnav.scss";

@import "breadcrumb.scss";

@import "pagination.scss";

@import "tab.scss";

@import "slidenav.scss";

@import "dotnav.scss";

@import "thumbnav.scss";

@import "iconnav.scss";

@import "lightbox.scss";

// Utilities

@import "animation.scss";

@import "width.scss";

@import "height.scss";

@import "text.scss";

@import "column.scss";

@import "background.scss";

@import "align.scss";

@import "utility.scss";

@import "margin.scss";

@import "padding.scss";

@import "position.scss";

@import "transition.scss";

@import "inverse.scss";

Fichier `assets/uikit/src/scss/components/_import.scss`

Ce fichier est, à la base, une copie conforme du fichier source https://github.com/uikit/uikit/blob/v3.6.19/scss/components/_import.scss.

Commenter tous les composants dont vous n’aurez pas besoin pour votre build custom:

// Base
@import "variables.scss";
@import "mixin.scss";
@import "base.scss";

// Elements
@import "link.scss";
//@import "heading.scss";
//@import "divider.scss";
//@import "list.scss";
//@import "description-list.scss";
//@import "table.scss";
@import "icon.scss";
//@import "form-range.scss";
//@import "form.scss"; // After: Icon, Form Range
@import "button.scss";
//@import "progress.scss";

// Layout
//@import "section.scss";
//@import "container.scss";
//@import "tile.scss";
//@import "card.scss";

// Common
@import "close.scss"; // After: Icon
//@import "spinner.scss"; // After: Icon
//@import "totop.scss"; // After: Icon
//@import "marker.scss"; // After: Icon
//@import "alert.scss"; // After: Close
//@import "placeholder.scss";
//@import "badge.scss";
//@import "label.scss";
//@import "overlay.scss"; // After: Icon
//@import "article.scss";
//@import "comment.scss";
//@import "search.scss"; // After: Icon

// JavaScript
@import "accordion.scss";
//@import "drop.scss"; // After: Card
//@import "dropdown.scss"; // After: Card
//@import "modal.scss"; // After: Close
//@import "slideshow.scss";
//@import "slider.scss";
//@import "sticky.scss";
//@import "offcanvas.scss";
//@import "switcher.scss";
//@import "leader.scss";
@import "notification.scss";
//@import "tooltip.scss";
//@import "sortable.scss";
@import "countdown.scss";
// Scrollspy
// Toggle
// Scroll

@import "grid.scss";

// Navs
//@import "nav.scss";
//@import "navbar.scss"; // After: Card, Grid, Nav, Icon, Search
//@import "subnav.scss";
//@import "breadcrumb.scss";
//@import "pagination.scss";
//@import "tab.scss";
//@import "slidenav.scss"; // After: Icon
//@import "dotnav.scss";
//@import "thumbnav.scss";
//@import "iconnav.scss";

//@import "lightbox.scss"; // After: Close, Slidenav

// Utilities
//@import "animation.scss";
//@import "width.scss";
//@import "height.scss";
//@import "text.scss";
//@import "column.scss";
//@import "cover.scss";
//@import "background.scss";
//@import "align.scss";
//@import "svg.scss";
//@import "utility.scss";
//@import "flex.scss"; // After: Utility
//@import "margin.scss";
//@import "padding.scss";
//@import "position.scss";
//@import "transition.scss";
//@import "visibility.scss";
//@import "inverse.scss";

// Need to be loaded last
//@import "print.scss";

// Base

@import "variables.scss";

@import "mixin.scss";

@import "base.scss";

// Elements

@import "link.scss";

//@import "heading.scss";

//@import "divider.scss";

//@import "list.scss";

//@import "description-list.scss";

//@import "table.scss";

@import "icon.scss";

//@import "form-range.scss";

//@import "form.scss"; // After: Icon, Form Range

@import "button.scss";

//@import "progress.scss";

// Layout

//@import "section.scss";

//@import "container.scss";

//@import "tile.scss";

//@import "card.scss";

// Common

@import "close.scss"; // After: Icon

//@import "spinner.scss"; // After: Icon

//@import "totop.scss"; // After: Icon

//@import "marker.scss"; // After: Icon

//@import "alert.scss"; // After: Close

//@import "placeholder.scss";

//@import "badge.scss";

//@import "label.scss";

//@import "overlay.scss"; // After: Icon

//@import "article.scss";

//@import "comment.scss";

//@import "search.scss"; // After: Icon

// JavaScript

@import "accordion.scss";

//@import "drop.scss"; // After: Card

//@import "dropdown.scss"; // After: Card

//@import "modal.scss"; // After: Close

//@import "slideshow.scss";

//@import "slider.scss";

//@import "sticky.scss";

//@import "offcanvas.scss";

//@import "switcher.scss";

//@import "leader.scss";

@import "notification.scss";

//@import "tooltip.scss";

//@import "sortable.scss";

@import "countdown.scss";

// Scrollspy

// Toggle

// Scroll

@import "grid.scss";

// Navs

//@import "nav.scss";

//@import "navbar.scss"; // After: Card, Grid, Nav, Icon, Search

//@import "subnav.scss";

//@import "breadcrumb.scss";

//@import "pagination.scss";

//@import "tab.scss";

//@import "slidenav.scss"; // After: Icon

//@import "dotnav.scss";

//@import "thumbnav.scss";

//@import "iconnav.scss";

//@import "lightbox.scss"; // After: Close, Slidenav

// Utilities

//@import "animation.scss";

//@import "width.scss";

//@import "height.scss";

//@import "text.scss";

//@import "column.scss";

//@import "cover.scss";

//@import "background.scss";

//@import "align.scss";

//@import "svg.scss";

//@import "utility.scss";

//@import "flex.scss"; // After: Utility

//@import "margin.scss";

//@import "padding.scss";

//@import "position.scss";

//@import "transition.scss";

//@import "visibility.scss";

//@import "inverse.scss";

// Need to be loaded last

//@import "print.scss";

Les fichiers JS

Fichier `assets/app.js`

On importe le fichier SCSS « racine/maître » app.scss. C’est celui qui va concentrer l’ensemble des @import des différents composants.
On importe le bundle^* de notre sélection de composants JS via la directive import UIkit from 'uikit';.
On importe le bundle^* de notre sélection d’icônes via les directives import Icons from 'uikit/dist/js/uikit-icons'; UIkit.use(Icons);
On initialise un composant Notification (test)

*: j’explique ça juste en-dessous.

// Styles
import './styles/app.scss';

// JS (from custom build generated in ./node_modules/uikit/dist/ folder)
import UIkit from 'uikit';

// Icons must be imported separately (from custom build generated in ./node_modules/uikit/dist/ folder)
import Icons from 'uikit/dist/js/uikit-icons';
UIkit.use(Icons);

// Exemple of Notification component inititalization
UIkit.notification("Hello World!");

// Styles

import './styles/app.scss';

// JS (from custom build generated in ./node_modules/uikit/dist/ folder)

import UIkit from 'uikit';

// Icons must be imported separately (from custom build generated in ./node_modules/uikit/dist/ folder)

import Icons from 'uikit/dist/js/uikit-icons';

UIkit.use(Icons);

// Exemple of Notification component inititalization

UIkit.notification("Hello World!");

Fichier `assets/uikit/src/js/core/index.js`

Ce fichier est, à la base, une copie conforme du fichier source https://github.com/uikit/uikit/blob/v3.6.19/src/js/core/index.js.

Commenter tous les composants dont vous n’aurez pas besoin pour votre build custom:

export {default as Accordion} from './accordion';
// export {default as Alert} from './alert';
// export {default as Cover} from './cover';
// export {default as Drop, default as Dropdown} from './drop';
// export {default as FormCustom} from './form-custom';
// export {default as Gif} from './gif';
// export {default as Grid} from './grid';
// export {default as HeightMatch} from './height-match';
// export {default as HeightViewport} from './height-viewport';
export {default as Icon} from './icon';
// export {default as Img} from './img';
// export {default as Leader} from './leader';
// export {default as Margin} from './margin';
// export {default as Modal} from './modal';
// export {default as Nav} from './nav';
// export {default as Navbar} from './navbar';
// export {default as Offcanvas} from './offcanvas';
// export {default as OverflowAuto} from './overflow-auto';
// export {default as Responsive} from './responsive';
// export {default as Scroll} from './scroll';
// export {default as Scrollspy} from './scrollspy';
// export {default as ScrollspyNav} from './scrollspy-nav';
// export {default as Sticky} from './sticky';
// export {default as Svg} from './svg';
// export {default as Switcher} from './switcher';
// export {default as Tab} from './tab';
// export {default as Toggle} from './toggle';
// export {default as Video} from './video';

// Icon components
export {Close} from './icon';
// export {Spinner} from './icon';
// export {Slidenav as SlidenavNext} from './icon';
// export {Slidenav as SlidenavPrevious} from './icon';
// export {Search as SearchIcon} from './icon';
// export {IconComponent as Marker} from './icon';
// export {IconComponent as NavbarToggleIcon} from './icon';
// export {IconComponent as OverlayIcon} from './icon';
// export {IconComponent as PaginationNext} from './icon';
// export {IconComponent as PaginationPrevious} from './icon';
// export {IconComponent as Totop} from './icon';

export {default as Accordion} from './accordion';

// export {default as Alert} from './alert';

// export {default as Cover} from './cover';

// export {default as Drop, default as Dropdown} from './drop';

// export {default as FormCustom} from './form-custom';

// export {default as Gif} from './gif';

// export {default as Grid} from './grid';

// export {default as HeightMatch} from './height-match';

// export {default as HeightViewport} from './height-viewport';

export {default as Icon} from './icon';

// export {default as Img} from './img';

// export {default as Leader} from './leader';

// export {default as Margin} from './margin';

// export {default as Modal} from './modal';

// export {default as Nav} from './nav';

// export {default as Navbar} from './navbar';

// export {default as Offcanvas} from './offcanvas';

// export {default as OverflowAuto} from './overflow-auto';

// export {default as Responsive} from './responsive';

// export {default as Scroll} from './scroll';

// export {default as Scrollspy} from './scrollspy';

// export {default as ScrollspyNav} from './scrollspy-nav';

// export {default as Sticky} from './sticky';

// export {default as Svg} from './svg';

// export {default as Switcher} from './switcher';

// export {default as Tab} from './tab';

// export {default as Toggle} from './toggle';

// export {default as Video} from './video';

// Icon components

export {Close} from './icon';

// export {Spinner} from './icon';

// export {Slidenav as SlidenavNext} from './icon';

// export {Slidenav as SlidenavPrevious} from './icon';

// export {Search as SearchIcon} from './icon';

// export {IconComponent as Marker} from './icon';

// export {IconComponent as NavbarToggleIcon} from './icon';

// export {IconComponent as OverlayIcon} from './icon';

// export {IconComponent as PaginationNext} from './icon';

// export {IconComponent as PaginationPrevious} from './icon';

// export {IconComponent as Totop} from './icon';

Fichier `assets/uikit/src/js/components/index.js`

Ce fichier est, à la base, une copie conforme du fichier source https://github.com/uikit/uikit/blob/v3.6.19/src/js/components/index.js.

Commenter tous les composants dont vous n’aurez pas besoin pour votre build custom:

export {default as Countdown} from './countdown';
// export {default as Filter} from './filter';
// export {default as Lightbox} from './lightbox';
// export {default as LightboxPanel} from './lightbox-panel';
export {default as Notification} from './notification';
// export {default as Parallax} from './parallax';
// export {default as Slider} from './slider';
// export {default as SliderParallax} from './slider-parallax';
// export {default as Slideshow} from './slideshow';
// export {default as SlideshowParallax} from './slideshow-parallax';
// export {default as Sortable} from './sortable';
// export {default as Tooltip} from './tooltip';
// export {default as Upload} from './upload';

export {default as Countdown} from './countdown';

// export {default as Filter} from './filter';

// export {default as Lightbox} from './lightbox';

// export {default as LightboxPanel} from './lightbox-panel';

export {default as Notification} from './notification';

// export {default as Parallax} from './parallax';

// export {default as Slider} from './slider';

// export {default as SliderParallax} from './slider-parallax';

// export {default as Slideshow} from './slideshow';

// export {default as SlideshowParallax} from './slideshow-parallax';

// export {default as Sortable} from './sortable';

// export {default as Tooltip} from './tooltip';

// export {default as Upload} from './upload';

Les icônes

Structure des dossiers (à respecter)

Attention: la documentation d’UIkit vous explique comment remplacer des icônes existantes ou ajouter de nouvelles icônes à votre projet.
Cependant, cette dernière fait mention d’un dossier custom/ dans lequel placer les nouvelles icônes à ajouter à votre projet (avant d’effectuer votre build)… sans préciser à quel endroit de l’arborescence des fichiers du framework celui-ci devrait se trouver (edit: dans src/custom/icons/)!

La manipulation des icônes fonctionnera très bien si vous déposez vos fichiers de remplacement et vos nouveaux fichiers dans l’un des 3 dossiers suivants:

Icônes des… erm… (reste à définir): ./assets/uikit/src/images/backgrounds/
Icônes des composants: ./assets/uikit/src/images/components/
Icônes de la bibliothèque d’icônes: ./assets/uikit/src/images/icons/

Note: dans le cas où une même icône est utilisée pour un ou plusieurs composants ET dans la bibliothèque (la croix de fermeture par exemple, présente au minimum dans le composant Notification ET dans la bibliothèque), le fichier doit être présent dans les deux dossiers ./assets/uikit/src/images/components/close-icon.svg et ./assets/uikit/src/images/icons/close.svg (libellé différent, et le code peut-être différent également pour une même icône, cf. ici (components/close-icon.svg) et là (icons/close.svg)).

Fichier `assets/uikit/build/util.js`

Ce fichier est, à la base, une copie conforme du fichier source https://github.com/uikit/uikit/blob/v3.6.19/build/util.js.

Je ne donne ci-dessous que la constante const svgo = new SVGO qui est à modifier avec l’ajout de deux nouveaux paramètres, mais l’intégralité du code issu du fichier source est, bien entendu, à conserver!:

removeAttrs qui va s’occuper de nettoyer le fichier SVG source en supprimant des attributs, inutiles pour nous, qu’on va par exemple retrouver dans les icônes issues de la populaire bibliothèque Font Awesome.
addAttributesToSVGElement qui va s’occuper d’ajouter les attributs width="20" et height="20", nécessaires au bon fonctionnement de la bibliothèque d’icônes UIkit, là où ils manquent. Attention: si ces attributs existent déjà avec des valeurs similaires ou d’autres valeurs, ils ne seront pas écrasés par ce paramètre!

[...]

exports.icons = async function (src) {

    const svgo = new SVGO({

        plugins: [
            {removeViewBox: false},
            {
                cleanupNumericValues: {
                    floatPrecision: 3
                }
            },
            {convertPathData: false},
            {convertShapeToPath: false},
            {mergePaths: false},
            {removeDimensions: false},
            {removeStyleElement: false},
            {removeScriptElement: false},
            {removeUnknownsAndDefaults: false},
            {removeUselessStrokeAndFill: false},
            // Remove unwanted attributes
            // https://github.com/svg/svgo/blob/v1.3.2/examples/test.js#L75
            {removeAttrs: {attrs: '(id|class|aria-hidden|focusable|data-prefix|data-icon|role)'}},
            // Add "width" and "height" attributes (where missing) with a value of "20"
            // /!\ Needs to be an array!
            // /!\ Existant "width" and "height" attributes WON'T be replaced!
            // https://github.com/svg/svgo/issues/583#issuecomment-275941582
            {addAttributesToSVGElement: {attributes: ['width="20"', 'height="20"']}}
        ]

    });

[...]

[...]

exports.icons = async function (src) {

const svgo = new SVGO({

plugins: [

{removeViewBox: false},

{

cleanupNumericValues: {

floatPrecision: 3

}

{convertPathData: false},

{convertShapeToPath: false},

{mergePaths: false},

{removeDimensions: false},

{removeStyleElement: false},

{removeScriptElement: false},

{removeUnknownsAndDefaults: false},

{removeUselessStrokeAndFill: false},

// Remove unwanted attributes

// https://github.com/svg/svgo/blob/v1.3.2/examples/test.js#L75

{removeAttrs: {attrs: '(id|class|aria-hidden|focusable|data-prefix|data-icon|role)'}},

// Add "width" and "height" attributes (where missing) with a value of "20"

// /!\ Needs to be an array!

// /!\ Existant "width" and "height" attributes WON'T be replaced!

// https://github.com/svg/svgo/issues/583#issuecomment-275941582

{addAttributesToSVGElement: {attributes: ['width="20"', 'height="20"']}}

]

});

[...]

Petit récapitulatif de l’arborescence attendue

…sous forme de capture d’écran.

Le script bash

Nouvelle méthode (au 04/05/2021):

Dans le fichier package.json qui devrait se trouver à la racine de votre projet, nous allons ajouter un script qui va générer automatiquement les sources dist optimisées d’UIkit:

{
    "scripts": {
      "uk": "./build/build-uikit.sh"
    },
    "devDependencies": {

    [...]

}

{

"scripts": {

"uk": "./build/build-uikit.sh"

"devDependencies": {

[...]

}

Nous allons ensuite créer un fichier build/build-uikit.sh qui va contenir le script en question:

#!/usr/bin/env bash

# Rendre ce script exécutable:
# chmod +x ./build/build-uikit.sh

# Générer les sources JS et le sprite d'icônes SVG:
# $ yarn run uk

# Générer uniquement les sources JS:
# $ yarn run uk uikit

# Générer uniquement le sprite d'icônes SVG:
# $ yarn run uk icons

cp -r assets/uikit/* node_modules/uikit/
cd node_modules/uikit

# Si le dossier "node_modules" n'existe pas:
if [ ! -d "node_modules" ]
then
  npm install
fi

# Possibilité de passer des arguments:
array=("$@")

# Si pas d'arguments, on execute la commande par défaut:
if [ $# -eq 0 ]
then
  node build/build uikit icons -d

# Sinon, on exécute la commande en fonction des arguments passés:
else
  node build/build $@ -d
fi

#!/usr/bin/env bash

# Rendre ce script exécutable:

# chmod +x ./build/build-uikit.sh

# Générer les sources JS et le sprite d'icônes SVG:

# $ yarn run uk

# Générer uniquement les sources JS:

# $ yarn run uk uikit

# Générer uniquement le sprite d'icônes SVG:

# $ yarn run uk icons

cp -r assets/uikit/* node_modules/uikit/

cd node_modules/uikit

# Si le dossier "node_modules" n'existe pas:

if [ ! -d "node_modules" ]

then

npm install

# Possibilité de passer des arguments:

array=("$@")

# Si pas d'arguments, on execute la commande par défaut:

if [ $# -eq 0 ]

then

node build/build uikit icons -d

# Sinon, on exécute la commande en fonction des arguments passés:

else

node build/build $@ -d

ATTENTION: afin de rendre ce script exécutable, il faut lancer depuis la racine de votre projet la commande chmod +x ./build/build-uikit.sh!

Désormais, vous pourrez lancer différentes commandes pour générer votre build à la carte d’UIkit:

yarn run uk: générer les sources JS et le sprite d’icônes SVG d’UIkit
yarn run uk uikit: générer uniquement les sources JS d’UIkit
yarn run uk icons: générer uniquement le sprite d’icônes SVG d’UIkit

Note: nous n’avons bien sûr pas de commande relative aux styles car ils sont générés directement via Webpack Encore.

Méthode précédente (dépréciée):

Attention: les sources du framework front-end UIkit consignées dans le dossier node_modules/ de votre projet ont leur propre fichier package.json. Pour exécuter les différents scripts de build, il convient donc d’avoir au préalable déployé les dépendances Node au sein du dossier à l’aide de la commande npm install. En d’autres termes, si le dossier node_modules n’est pas présent dans le dossier ./node_modules/uikit/, les commandes de build vont vous péter à la tronche :D.

Depuis la racine de votre projet:

On copie nos fichiers custom d’UIkit vers le dossier où sont consignées les sources issues du Git officiel (les fichiers initiaux existants seront écrasés par les nôtres; c’est ce qu’on veut):

cp -r assets/uikit/* node_modules/uikit/

1	cp -r assets/uikit/* node_modules/uikit/

On se rend dans le dossier où sont consignées les sources d’UIkit:

cd node_modules/uikit

1	cd node_modules/uikit

La manipulation suiffante n’est à effectuer que dans deux cas:

Vous n’avez encore jamais lancé la commande npm install depuis ce dossier et le dossier node_modules n’est donc pas présent à la racine de ./node_modules/uikit/.
Vous avez effectué des modifications dans le fichier ./node_modules/uikit/package.json (vérifier que ce fichier est présent dans ./assets/uikit/; ça peut être une bonne indication du fait qu’il faille lancer les deux commandes ci-dessous).

rm -rf node_modules
npm install

1 2	rm -rf node_modules npm install

Effectuer un build non-minifié (paramètre -d – c’est Webpack Encore qui assurera la minification par la suite) des sources JS d’UIkit qui contient uniquement notre sélection de composants et la bibliothèque d’icônes:

node build/build uikit icons -d

1	node build/build uikit icons -d

Note: voir les autres paramètres possibles pour la commande node build/build.

On retourne à la racine de notre projet et on lance la commande de build propre à Webpack Encore:

cd ../..
yarn encore dev|yarn encore production

1 2	cd ../.. yarn encore dev\|yarn encore production

Vos sources pour afficher votre site dans le navigateur sont prêtes!

Quelques chiffres suite à mes tests

[339 KB] Build JS standard d’UIkit non-minifié (comprend tout le core et tous les composants)
[136,5 KB] Build JS à la carte d’UIkit non-minifié (comprend uniquement les fonctionnalités du core nécessaires au fonctionnement de ma sélection de composants et les composants suivants: core: accordion, icon | components: countdown, notification – cf. Fichiers JS)
[130 KB] Build JS standard d’UIkit minifié via les fonctionnalités de build fournies avec le framework
[52,7 KB] Build JS à la carte d’UIkit minifié via Webpack Encore

Caveats connus!

Les icônes des composants, si elles proviennent d’une autre source que la bibliothèque UIkit, ne sont pas nettoyées par par les modifications apportées au script de build de cette dernière ce qui occasionne des soucis d’affichage. Solution de correction possible: passer au préalable par Webpack (plutôt que par une modification des scripts de build d’UIkit) pour nettoyer tous les SVG et les rendre « UIkit-compliant » avant de les envoyer vers ./node_modules/uikit/* et d’effectuer un build.

Méthode alternative (attention: limitations connues au niveau des icônes)

ATTENTION: plusieurs limitations au niveau des icônes avec cette méthode de bundle:

Les icônes des composants ne s’affichent pas (cf. Diagnostique des erreurs ci-dessous).
Si la bibliothèque d’icônes (générée séparément) s’affiche bien, cette méthode ne permet de personnaliser celle-ci en ajoutant/supprimant des icônes.

Diagnostique des erreurs:

M’affiche l’erreur suivante en console:

fastdom.js:67 TypeError: Cannot read property ‘cloneNode’ of undefined
at getIcon (icon.js:186)
at UIkitComponent.getSvg (icon.js:63)
at UIkitComponent.connected (svg.js:38)
at hooks.js:10
at Array.forEach ()
at UIkitComponent.UIkit._callHook (hooks.js:10)
at UIkitComponent.UIkit._callConnected (hooks.js:31)
at UIkitComponent.UIkit.$mount (instance.js:28)
at UIkitComponent.UIkit._init (state.js:23)
at new UIkitComponent (global.js:30)

Les icônes des composants sont générées séparément du sprite d’icônes utilisables à la carte (et qui, lui, fonctionne!).
Lorsque je compare aux sources JS fournies dans le dossier dist, je remarque l’absence du code suivant dans mon bundle Webpack:

var closeIcon = "<svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" xmlns=\"http://www.w3.org/2000/svg\"><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"1\" y1=\"1\" x2=\"13\" y2=\"13\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"13\" y1=\"1\" x2=\"1\" y2=\"13\"/></svg>";
var closeLarge = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" x1=\"1\" y1=\"1\" x2=\"19\" y2=\"19\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" x1=\"19\" y1=\"1\" x2=\"1\" y2=\"19\"/></svg>";
var marker = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><rect x=\"9\" y=\"4\" width=\"1\" height=\"11\"/><rect x=\"4\" y=\"9\" width=\"11\" height=\"1\"/></svg>";
var navbarToggleIcon = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><rect y=\"9\" width=\"20\" height=\"2\"/><rect y=\"3\" width=\"20\" height=\"2\"/><rect y=\"15\" width=\"20\" height=\"2\"/></svg>";
var overlayIcon = "<svg width=\"40\" height=\"40\" viewBox=\"0 0 40 40\" xmlns=\"http://www.w3.org/2000/svg\"><rect x=\"19\" y=\"0\" width=\"1\" height=\"40\"/><rect x=\"0\" y=\"19\" width=\"40\" height=\"1\"/></svg>";
var paginationNext = "<svg width=\"7\" height=\"12\" viewBox=\"0 0 7 12\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"1 1 6 6 1 11\"/></svg>";
var paginationPrevious = "<svg width=\"7\" height=\"12\" viewBox=\"0 0 7 12\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"6 1 1 6 6 11\"/></svg>";
var searchIcon = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" cx=\"9\" cy=\"9\" r=\"7\"/><path fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" d=\"M14,14 L18,18 L14,14 Z\"/></svg>";
var searchLarge = "<svg width=\"40\" height=\"40\" viewBox=\"0 0 40 40\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.8\" cx=\"17.5\" cy=\"17.5\" r=\"16.5\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.8\" x1=\"38\" y1=\"39\" x2=\"29\" y2=\"30\"/></svg>";
var searchNavbar = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" cx=\"10.5\" cy=\"10.5\" r=\"9.5\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"23\" y1=\"23\" x2=\"17\" y2=\"17\"/></svg>";
var slidenavNext = "<svg width=\"14\" height=\"24\" viewBox=\"0 0 14 24\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" points=\"1.225,23 12.775,12 1.225,1 \"/></svg>";
var slidenavNextLarge = "<svg width=\"25\" height=\"40\" viewBox=\"0 0 25 40\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"2\" points=\"4.002,38.547 22.527,20.024 4,1.5 \"/></svg>";
var slidenavPrevious = "<svg width=\"14\" height=\"24\" viewBox=\"0 0 14 24\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" points=\"12.775,1 1.225,12 12.775,23 \"/></svg>";
var slidenavPreviousLarge = "<svg width=\"25\" height=\"40\" viewBox=\"0 0 25 40\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"2\" points=\"20.527,1.5 2,20.024 20.525,38.547 \"/></svg>";
var spinner = "<svg width=\"30\" height=\"30\" viewBox=\"0 0 30 30\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" cx=\"15\" cy=\"15\" r=\"14\"/></svg>";
var totop = "<svg width=\"18\" height=\"10\" viewBox=\"0 0 18 10\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"1 9 9 1 17 9 \"/></svg>";

var closeIcon = "<svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" xmlns=\"http://www.w3.org/2000/svg\"><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"1\" y1=\"1\" x2=\"13\" y2=\"13\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"13\" y1=\"1\" x2=\"1\" y2=\"13\"/></svg>";

var closeLarge = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" x1=\"1\" y1=\"1\" x2=\"19\" y2=\"19\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" x1=\"19\" y1=\"1\" x2=\"1\" y2=\"19\"/></svg>";

var marker = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><rect x=\"9\" y=\"4\" width=\"1\" height=\"11\"/><rect x=\"4\" y=\"9\" width=\"11\" height=\"1\"/></svg>";

var navbarToggleIcon = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><rect y=\"9\" width=\"20\" height=\"2\"/><rect y=\"3\" width=\"20\" height=\"2\"/><rect y=\"15\" width=\"20\" height=\"2\"/></svg>";

var overlayIcon = "<svg width=\"40\" height=\"40\" viewBox=\"0 0 40 40\" xmlns=\"http://www.w3.org/2000/svg\"><rect x=\"19\" y=\"0\" width=\"1\" height=\"40\"/><rect x=\"0\" y=\"19\" width=\"40\" height=\"1\"/></svg>";

var paginationNext = "<svg width=\"7\" height=\"12\" viewBox=\"0 0 7 12\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"1 1 6 6 1 11\"/></svg>";

var paginationPrevious = "<svg width=\"7\" height=\"12\" viewBox=\"0 0 7 12\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"6 1 1 6 6 11\"/></svg>";

var searchIcon = "<svg width=\"20\" height=\"20\" viewBox=\"0 0 20 20\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" cx=\"9\" cy=\"9\" r=\"7\"/><path fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" d=\"M14,14 L18,18 L14,14 Z\"/></svg>";

var searchLarge = "<svg width=\"40\" height=\"40\" viewBox=\"0 0 40 40\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.8\" cx=\"17.5\" cy=\"17.5\" r=\"16.5\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.8\" x1=\"38\" y1=\"39\" x2=\"29\" y2=\"30\"/></svg>";

var searchNavbar = "<svg width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" cx=\"10.5\" cy=\"10.5\" r=\"9.5\"/><line fill=\"none\" stroke=\"#000\" stroke-width=\"1.1\" x1=\"23\" y1=\"23\" x2=\"17\" y2=\"17\"/></svg>";

var slidenavNext = "<svg width=\"14\" height=\"24\" viewBox=\"0 0 14 24\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" points=\"1.225,23 12.775,12 1.225,1 \"/></svg>";

var slidenavNextLarge = "<svg width=\"25\" height=\"40\" viewBox=\"0 0 25 40\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"2\" points=\"4.002,38.547 22.527,20.024 4,1.5 \"/></svg>";

var slidenavPrevious = "<svg width=\"14\" height=\"24\" viewBox=\"0 0 14 24\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.4\" points=\"12.775,1 1.225,12 12.775,23 \"/></svg>";

var slidenavPreviousLarge = "<svg width=\"25\" height=\"40\" viewBox=\"0 0 25 40\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"2\" points=\"20.527,1.5 2,20.024 20.525,38.547 \"/></svg>";

var spinner = "<svg width=\"30\" height=\"30\" viewBox=\"0 0 30 30\" xmlns=\"http://www.w3.org/2000/svg\"><circle fill=\"none\" stroke=\"#000\" cx=\"15\" cy=\"15\" r=\"14\"/></svg>";

var totop = "<svg width=\"18\" height=\"10\" viewBox=\"0 0 18 10\" xmlns=\"http://www.w3.org/2000/svg\"><polyline fill=\"none\" stroke=\"#000\" stroke-width=\"1.2\" points=\"1 9 9 1 17 9 \"/></svg>";

Pas de résolution à ce jour.

Fichiers impliqués

Fichier `assets/app.js`

// Styles
import './uikit-explicit-pieces.scss'
// JS
import UIkit from './uikit-explicit-pieces';

// UIkit
UIkit.notification("Hello World!");

// Styles

import './uikit-explicit-pieces.scss'

// JS

import UIkit from './uikit-explicit-pieces';

// UIkit

UIkit.notification("Hello World!");

Fichier `webpack.config.js`:

const Encore = require('@symfony/webpack-encore');
const path = require('path');

[...]

Encore
    .addAliases({
        // UIkit JS:
        'uikit-util': path.resolve(__dirname, './node_modules/uikit/src/js/util'),
        '@uk-js': path.resolve(__dirname, './node_modules/uikit/src/js'),
        '@uk-scss': path.resolve(__dirname, './node_modules/uikit/src/scss')
    })

[...]

    // enables Sass/SCSS support
    .enableSassLoader()

const Encore = require('@symfony/webpack-encore');

const path = require('path');

[...]

Encore

.addAliases({

// UIkit JS:

'uikit-util': path.resolve(__dirname, './node_modules/uikit/src/js/util'),

'@uk-js': path.resolve(__dirname, './node_modules/uikit/src/js'),

'@uk-scss': path.resolve(__dirname, './node_modules/uikit/src/scss')

})

[...]

// enables Sass/SCSS support

.enableSassLoader()

Bundle Javascript – Fichier `assets/uikit-explicit-pieces.js`:

/*
 * Based on: UIkit v3.6.19
 * Source: https://github.com/uikit/uikit/tree/v3.6.19
 * Documentation: https://getuikit.com/docs/javascript
 */

/*
 * Overrides:
 * ./node_modules/uikit/src/js/uikit-core.js
 * ./node_modules/uikit/src/js/uikit.js
 */

// import UIkit from 'uikit/src/js/api/index';

    /*
     * Overrides:
     * ./node_modules/uikit/src/js/api/index.js
     *
     * Override needed because of the "UIkit.version = VERSION;" line that generates an
     * "Uncaught ReferenceError: VERSION is not defined" error in browser console!
     */

    import globalAPI from '@uk-js/api/global';
    import hooksAPI from '@uk-js/api/hooks';
    import stateAPI from '@uk-js/api/state';
    import instanceAPI from '@uk-js/api/instance';
    import componentAPI from '@uk-js/api/component';
    import * as util from 'uikit-util';

    const UIkit = function (options) {
        this._init(options);
    };

    UIkit.util = util;
    UIkit.data = '__uikit__';
    UIkit.prefix = 'uk-';
    UIkit.options = {};
    // UIkit.version = VERSION;

    globalAPI(UIkit);
    hooksAPI(UIkit);
    stateAPI(UIkit);
    componentAPI(UIkit);
    instanceAPI(UIkit);

    /* END: Overrides: ./node_modules/uikit/src/js/api/index.js */

import Core from '@uk-js/core/core';
import boot from '@uk-js/api/boot';
// import * as components from 'uikit/src/js/core/index';

    /*
     * Overrides:
     * ./node_modules/uikit/src/js/core/index.js
     */

    import {Accordion,
            Alert,
            Cover,
            Drop, Dropdown,
            FormCustom,
            Gif,
            Grid,
            HeightMatch,
            HeightViewport,
            Icon,
            Img,
            Leader,
            Margin,
            Modal,
            Nav,
            Navbar,
            Offcanvas,
            OverflowAuto,
            Responsive,
            Scroll,
            Scrollspy,
            ScrollspyNav,
            Sticky,
            Svg,
            Switcher,
            Tab,
            Toggle,
            Video} from '@uk-js/core/index';

    // Icon components
    import {Close,
            Spinner,
            Slidenav as SlidenavNext,
            Slidenav as SlidenavPrevious,
            Search as SearchIcon,
            IconComponent as Marker,
            IconComponent as NavbarToggleIcon,
            IconComponent as OverlayIcon,
            IconComponent as PaginationNext,
            IconComponent as PaginationPrevious,
            IconComponent as Totop} from '@uk-js/core/icon';

    /* END: Overrides: ./node_modules/uikit/src/js/core/index.js */

/* From: ./node_modules/uikit/src/js/uikit.js */
// import * as components from 'uikit/src/js/components/index';

    /*
     * Overrides:
     * ./node_modules/uikit/src/js/components/index.js
     */

    import {Countdown,
            Filter,
            Lightbox,
            LightboxPanel,
            Notification,
            Parallax,
            Slider,
            SliderParallax,
            Slideshow,
            SlideshowParallax,
            Sortable,
            Tooltip,
            Upload} from '@uk-js/components/index';

    /* END: Overrides: ./node_modules/uikit/src/js/components/index.js */

import {each} from '@uk-js/util/lang';

// register components
/* Declare your selection of UIkit components to be included in the Webpack build and registered here: */
const components = {
    /* Core components */
    Accordion,
    Alert,
    Cover,
    Drop, Dropdown,
    FormCustom,
    Gif,
    Grid,
    HeightMatch,
    HeightViewport,
    Icon,
    Img,
    Leader,
    Margin,
    Modal,
    Nav,
    Navbar,
    Offcanvas,
    OverflowAuto,
    Responsive,
    Scroll,
    Scrollspy,
    ScrollspyNav,
    Sticky,
    Svg,
    Switcher,
    Tab,
    Toggle,
    Video,

    /* Core components: icon */
    Close,
    Spinner,
    SlidenavNext,
    SlidenavPrevious,
    SearchIcon,
    Marker,
    NavbarToggleIcon,
    OverlayIcon,
    PaginationNext,
    PaginationPrevious,
    Totop,

    /* Additional components */
    Countdown,
    Filter,
    Lightbox,
    LightboxPanel,
    Notification,
    Parallax,
    Slider,
    SliderParallax,
    Slideshow,
    SlideshowParallax,
    Sortable,
    Tooltip,
    Upload
};

each(components, (component, name) =>
    UIkit.component(name, component)
);

// core functionality
UIkit.use(Core);

/* Icons must be imported separately, from node_modules/uikit/dist/ folder */
import Icons from 'uikit/dist/js/uikit-icons';
UIkit.use(Icons);

boot(UIkit);

/* END: Overrides: ./node_modules/uikit/src/js/uikit-core.js, ./node_modules/uikit/src/js/uikit.js */

/* FINALLY, export everything into 'UIkit' object. */
export default UIkit;

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

* Based on: UIkit v3.6.19

* Source: https://github.com/uikit/uikit/tree/v3.6.19

* Documentation: https://getuikit.com/docs/javascript

* Overrides:

* ./node_modules/uikit/src/js/uikit-core.js

* ./node_modules/uikit/src/js/uikit.js

// import UIkit from 'uikit/src/js/api/index';

* Overrides:

* ./node_modules/uikit/src/js/api/index.js

* Override needed because of the "UIkit.version = VERSION;" line that generates an

* "Uncaught ReferenceError: VERSION is not defined" error in browser console!

import globalAPI from '@uk-js/api/global';

import hooksAPI from '@uk-js/api/hooks';

import stateAPI from '@uk-js/api/state';

import instanceAPI from '@uk-js/api/instance';

import componentAPI from '@uk-js/api/component';

import * as util from 'uikit-util';

const UIkit = function (options) {

this._init(options);

};

UIkit.util = util;

UIkit.data = '__uikit__';

UIkit.prefix = 'uk-';

UIkit.options = {};

// UIkit.version = VERSION;

globalAPI(UIkit);

hooksAPI(UIkit);

stateAPI(UIkit);

componentAPI(UIkit);

instanceAPI(UIkit);

/* END: Overrides: ./node_modules/uikit/src/js/api/index.js */

import Core from '@uk-js/core/core';

import boot from '@uk-js/api/boot';

// import * as components from 'uikit/src/js/core/index';

* Overrides:

* ./node_modules/uikit/src/js/core/index.js

import {Accordion,

Alert,

Cover,

Drop, Dropdown,

FormCustom,

Gif,

Grid,

HeightMatch,

HeightViewport,

Icon,

Img,

Leader,

Margin,

Modal,

Nav,

Navbar,

Offcanvas,

OverflowAuto,

Responsive,

Scroll,

Scrollspy,

ScrollspyNav,

Sticky,

Svg,

Switcher,

Tab,

Toggle,

Video} from '@uk-js/core/index';

// Icon components

import {Close,

Spinner,

Slidenav as SlidenavNext,

Slidenav as SlidenavPrevious,

Search as SearchIcon,

IconComponent as Marker,

IconComponent as NavbarToggleIcon,

IconComponent as OverlayIcon,

IconComponent as PaginationNext,

IconComponent as PaginationPrevious,

IconComponent as Totop} from '@uk-js/core/icon';

/* END: Overrides: ./node_modules/uikit/src/js/core/index.js */

/* From: ./node_modules/uikit/src/js/uikit.js */

// import * as components from 'uikit/src/js/components/index';

* Overrides:

* ./node_modules/uikit/src/js/components/index.js

import {Countdown,

Filter,

Lightbox,

LightboxPanel,

Notification,

Parallax,

Slider,

SliderParallax,

Slideshow,

SlideshowParallax,

Sortable,

Tooltip,

Upload} from '@uk-js/components/index';

/* END: Overrides: ./node_modules/uikit/src/js/components/index.js */

import {each} from '@uk-js/util/lang';

// register components

/* Declare your selection of UIkit components to be included in the Webpack build and registered here: */

const components = {

/* Core components */

Accordion,

Alert,

Cover,

Drop, Dropdown,

FormCustom,

Gif,

Grid,

HeightMatch,

HeightViewport,

Icon,

Img,

Leader,

Margin,

Modal,

Nav,

Navbar,

Offcanvas,

OverflowAuto,

Responsive,

Scroll,

Scrollspy,

ScrollspyNav,

Sticky,

Svg,

Switcher,

Tab,

Toggle,

Video,

/* Core components: icon */

Close,

Spinner,

SlidenavNext,

SlidenavPrevious,

SearchIcon,

Marker,

NavbarToggleIcon,

OverlayIcon,

PaginationNext,

PaginationPrevious,

Totop,

/* Additional components */

Countdown,

Filter,

Lightbox,

LightboxPanel,

Notification,

Parallax,

Slider,

SliderParallax,

Slideshow,

SlideshowParallax,

Sortable,

Tooltip,

Upload

};

each(components, (component, name) =>

UIkit.component(name, component)

);

// core functionality

UIkit.use(Core);

/* Icons must be imported separately, from node_modules/uikit/dist/ folder */

import Icons from 'uikit/dist/js/uikit-icons';

UIkit.use(Icons);

boot(UIkit);

/* END: Overrides: ./node_modules/uikit/src/js/uikit-core.js, ./node_modules/uikit/src/js/uikit.js */

/* FINALLY, export everything into 'UIkit' object. */

export default UIkit;

Bundle Styles – Fichier: `uikit-explicit-pieces.scss`:

/*
 * Based on: UIkit v3.6.19
 * Source: https://github.com/uikit/uikit/tree/v3.6.19
 * Documentation: https://getuikit.com/docs/sass
 */

/* 1. Your custom variables and variable overwrites. */
//$global-link-color: #DA7D02;

/* 2. Import default variables and available mixins. */
@import "@uk-scss/variables-theme.scss";
@import "@uk-scss/mixins-theme.scss";

/* 3. Your custom mixin overwrites. */
//@mixin hook-card() { color: #000; }

/* 4. Import UIkit here: */

/*
 * Overrides:
 * ./node_modules/uikit/src/scss/uikit-theme.scss
 */

//
// Theme
//

//@import "@uk-scss/theme/theme/_import.scss";

    /*
     * Overrides:
     * ./node_modules/uikit/src/scss/theme/_import.scss
     */

    /*
     * [DEV NOTE] Sachant que les fichiers importés ci-dessous sont relatifs au thème, ils devraient:
     * - N'être importés qu'à la condition qu'on souhaite personnaliser le rendu graphique du composant en question
     * - N'être importés de node_modules qu'à la condition qu'ils nous conviennent en l'état...
     * - ...sinon, être surchargés (en partant impérativement d'un copier-coller de l'original) et modifiés dans le thème
     */

    // Base
    //@import "@uk-scss/theme/variables.scss";
    //@import "@uk-scss/theme/base.scss";

    // Elements
    //@import "@uk-scss/theme/link.scss";
    //@import "@uk-scss/theme/heading.scss";
    //@import "@uk-scss/theme/divider.scss";
    //@import "@uk-scss/theme/list.scss";
    //@import "@uk-scss/theme/description-list.scss";
    //@import "@uk-scss/theme/table.scss";
    //@import "@uk-scss/theme/icon.scss";
    //@import "@uk-scss/theme/form-range.scss";
    //@import "@uk-scss/theme/form.scss";
    //@import "@uk-scss/theme/button.scss";
    //@import "@uk-scss/theme/progress.scss";

    // Layout
    //@import "@uk-scss/theme/section.scss";
    //@import "@uk-scss/theme/container.scss";
    //@import "@uk-scss/theme/tile.scss";
    //@import "@uk-scss/theme/card.scss";

    // Common
    //@import "@uk-scss/theme/close.scss";
    //@import "@uk-scss/theme/spinner.scss";
    //@import "@uk-scss/theme/marker.scss";
    //@import "@uk-scss/theme/totop.scss";
    //@import "@uk-scss/theme/alert.scss";
    //@import "@uk-scss/theme/placeholder.scss";
    //@import "@uk-scss/theme/badge.scss";
    //@import "@uk-scss/theme/label.scss";
    //@import "@uk-scss/theme/overlay.scss";
    //@import "@uk-scss/theme/article.scss";
    //@import "@uk-scss/theme/comment.scss";
    //@import "@uk-scss/theme/search.scss";

    // JavaScript
    //@import "@uk-scss/theme/accordion.scss";
    //@import "@uk-scss/theme/drop.scss";
    //@import "@uk-scss/theme/dropdown.scss";
    //@import "@uk-scss/theme/modal.scss";
    //@import "@uk-scss/theme/slider.scss";
    //@import "@uk-scss/theme/sticky.scss";
    //@import "@uk-scss/theme/offcanvas.scss";
    //@import "@uk-scss/theme/leader.scss";
    //@import "@uk-scss/theme/notification.scss";
    //@import "@uk-scss/theme/tooltip.scss";
    //@import "@uk-scss/theme/sortable.scss";
    //@import "@uk-scss/theme/countdown.scss";

    //@import "@uk-scss/theme/grid.scss";

    // Navs
    //@import "@uk-scss/theme/nav.scss";
    //@import "@uk-scss/theme/navbar.scss";
    //@import "@uk-scss/theme/subnav.scss";
    //@import "@uk-scss/theme/breadcrumb.scss";
    //@import "@uk-scss/theme/pagination.scss";
    //@import "@uk-scss/theme/tab.scss";
    //@import "@uk-scss/theme/slidenav.scss";
    //@import "@uk-scss/theme/dotnav.scss";
    //@import "@uk-scss/theme/thumbnav.scss";
    //@import "@uk-scss/theme/iconnav.scss";

    //@import "@uk-scss/theme/lightbox.scss";

    // Utilities
    //@import "@uk-scss/theme/animation.scss";
    //@import "@uk-scss/theme/width.scss";
    //@import "@uk-scss/theme/height.scss";
    //@import "@uk-scss/theme/text.scss";
    //@import "@uk-scss/theme/column.scss";
    //@import "@uk-scss/theme/background.scss";
    //@import "@uk-scss/theme/align.scss";
    //@import "@uk-scss/theme/utility.scss";
    //@import "@uk-scss/theme/margin.scss";
    //@import "@uk-scss/theme/padding.scss";
    //@import "@uk-scss/theme/position.scss";
    //@import "@uk-scss/theme/transition.scss";
    //@import "@uk-scss/theme/inverse.scss";

    /* END: Overrides: ./node_modules/uikit/src/scss/theme/_import.scss */

//@import "@uk-scss/theme/components/_import.scss";

    /*
     * Overrides:
     * ./node_modules/uikit/src/scss/components/_import.scss
     */

    // Base
    @import "@uk-scss/components/variables.scss";
    @import "@uk-scss/components/mixin.scss";
    @import "@uk-scss/components/base.scss";

    // Elements
    @import "@uk-scss/components/link.scss";
    @import "@uk-scss/components/heading.scss";
    @import "@uk-scss/components/divider.scss";
    @import "@uk-scss/components/list.scss";
    @import "@uk-scss/components/description-list.scss";
    @import "@uk-scss/components/table.scss";
    @import "@uk-scss/components/icon.scss";
    @import "@uk-scss/components/form-range.scss";
    @import "@uk-scss/components/form.scss"; // After: Icon, Form Range
    @import "@uk-scss/components/button.scss";
    @import "@uk-scss/components/progress.scss";

    // Layout
    @import "@uk-scss/components/section.scss";
    @import "@uk-scss/components/container.scss";
    @import "@uk-scss/components/tile.scss";
    @import "@uk-scss/components/card.scss";

    // Common
    @import "@uk-scss/components/close.scss"; // After: Icon
    @import "@uk-scss/components/spinner.scss"; // After: Icon
    @import "@uk-scss/components/totop.scss"; // After: Icon
    @import "@uk-scss/components/marker.scss"; // After: Icon
    @import "@uk-scss/components/alert.scss"; // After: Close
    @import "@uk-scss/components/placeholder.scss";
    @import "@uk-scss/components/badge.scss";
    @import "@uk-scss/components/label.scss";
    @import "@uk-scss/components/overlay.scss"; // After: Icon
    @import "@uk-scss/components/article.scss";
    @import "@uk-scss/components/comment.scss";
    @import "@uk-scss/components/search.scss"; // After: Icon

    // JavaScript
    @import "@uk-scss/components/accordion.scss";
    //@import "@uk-scss/components/drop.scss"; // After: Card
    //@import "@uk-scss/components/dropdown.scss"; // After: Card
    //@import "@uk-scss/components/modal.scss"; // After: Close
    //@import "@uk-scss/components/slideshow.scss";
    //@import "@uk-scss/components/slider.scss";
    //@import "@uk-scss/components/sticky.scss";
    //@import "@uk-scss/components/offcanvas.scss";
    //@import "@uk-scss/components/switcher.scss";
    //@import "@uk-scss/components/leader.scss";
    @import "@uk-scss/components/notification.scss";
    //@import "@uk-scss/components/tooltip.scss";
    //@import "@uk-scss/components/sortable.scss";
    @import "@uk-scss/components/countdown.scss";
    // Scrollspy
    // Toggle
    // Scroll

    @import "@uk-scss/components/grid.scss";

    // Navs
    @import "@uk-scss/components/nav.scss";
    @import "@uk-scss/components/navbar.scss"; // After: Card, Grid, Nav, Icon, Search
    @import "@uk-scss/components/subnav.scss";
    @import "@uk-scss/components/breadcrumb.scss";
    @import "@uk-scss/components/pagination.scss";
    @import "@uk-scss/components/tab.scss";
    @import "@uk-scss/components/slidenav.scss"; // After: Icon
    @import "@uk-scss/components/dotnav.scss";
    @import "@uk-scss/components/thumbnav.scss";
    @import "@uk-scss/components/iconnav.scss";

    @import "@uk-scss/components/lightbox.scss"; // After: Close, Slidenav

    // Utilities
    @import "@uk-scss/components/animation.scss";
    @import "@uk-scss/components/width.scss";
    @import "@uk-scss/components/height.scss";
    @import "@uk-scss/components/text.scss";
    @import "@uk-scss/components/column.scss";
    @import "@uk-scss/components/cover.scss";
    @import "@uk-scss/components/background.scss";
    @import "@uk-scss/components/align.scss";
    @import "@uk-scss/components/svg.scss";
    @import "@uk-scss/components/utility.scss";
    @import "@uk-scss/components/flex.scss"; // After: Utility
    @import "@uk-scss/components/margin.scss";
    @import "@uk-scss/components/padding.scss";
    @import "@uk-scss/components/position.scss";
    @import "@uk-scss/components/transition.scss";
    @import "@uk-scss/components/visibility.scss";
    @import "@uk-scss/components/inverse.scss";

    // Need to be loaded last
    @import "@uk-scss/components/print.scss";

    /* END: Overrides: ./node_modules/uikit/src/scss/components/_import.scss */

/* END: Overrides: ./node_modules/uikit/src/scss/uikit-theme.scss */

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

* Based on: UIkit v3.6.19

* Source: https://github.com/uikit/uikit/tree/v3.6.19

* Documentation: https://getuikit.com/docs/sass

/* 1. Your custom variables and variable overwrites. */

//$global-link-color: #DA7D02;

/* 2. Import default variables and available mixins. */

@import "@uk-scss/variables-theme.scss";

@import "@uk-scss/mixins-theme.scss";

/* 3. Your custom mixin overwrites. */

//@mixin hook-card() { color: #000; }

/* 4. Import UIkit here: */

* Overrides:

* ./node_modules/uikit/src/scss/uikit-theme.scss

// Theme

//@import "@uk-scss/theme/theme/_import.scss";

* Overrides:

* ./node_modules/uikit/src/scss/theme/_import.scss

* [DEV NOTE] Sachant que les fichiers importés ci-dessous sont relatifs au thème, ils devraient:

* - N'être importés qu'à la condition qu'on souhaite personnaliser le rendu graphique du composant en question

* - N'être importés de node_modules qu'à la condition qu'ils nous conviennent en l'état...

* - ...sinon, être surchargés (en partant impérativement d'un copier-coller de l'original) et modifiés dans le thème

// Base

//@import "@uk-scss/theme/variables.scss";

//@import "@uk-scss/theme/base.scss";

// Elements

//@import "@uk-scss/theme/link.scss";

//@import "@uk-scss/theme/heading.scss";

//@import "@uk-scss/theme/divider.scss";

//@import "@uk-scss/theme/list.scss";

//@import "@uk-scss/theme/description-list.scss";

//@import "@uk-scss/theme/table.scss";

//@import "@uk-scss/theme/icon.scss";

//@import "@uk-scss/theme/form-range.scss";

//@import "@uk-scss/theme/form.scss";

//@import "@uk-scss/theme/button.scss";

//@import "@uk-scss/theme/progress.scss";

// Layout

//@import "@uk-scss/theme/section.scss";

//@import "@uk-scss/theme/container.scss";

//@import "@uk-scss/theme/tile.scss";

//@import "@uk-scss/theme/card.scss";

// Common

//@import "@uk-scss/theme/close.scss";

//@import "@uk-scss/theme/spinner.scss";

//@import "@uk-scss/theme/marker.scss";

//@import "@uk-scss/theme/totop.scss";

//@import "@uk-scss/theme/alert.scss";

//@import "@uk-scss/theme/placeholder.scss";

//@import "@uk-scss/theme/badge.scss";

//@import "@uk-scss/theme/label.scss";

//@import "@uk-scss/theme/overlay.scss";

//@import "@uk-scss/theme/article.scss";

//@import "@uk-scss/theme/comment.scss";

//@import "@uk-scss/theme/search.scss";

// JavaScript

//@import "@uk-scss/theme/accordion.scss";

//@import "@uk-scss/theme/drop.scss";

//@import "@uk-scss/theme/dropdown.scss";

//@import "@uk-scss/theme/modal.scss";

//@import "@uk-scss/theme/slider.scss";

//@import "@uk-scss/theme/sticky.scss";

//@import "@uk-scss/theme/offcanvas.scss";

//@import "@uk-scss/theme/leader.scss";

//@import "@uk-scss/theme/notification.scss";

//@import "@uk-scss/theme/tooltip.scss";

//@import "@uk-scss/theme/sortable.scss";

//@import "@uk-scss/theme/countdown.scss";

//@import "@uk-scss/theme/grid.scss";

// Navs

//@import "@uk-scss/theme/nav.scss";

//@import "@uk-scss/theme/navbar.scss";

//@import "@uk-scss/theme/subnav.scss";

//@import "@uk-scss/theme/breadcrumb.scss";

//@import "@uk-scss/theme/pagination.scss";

//@import "@uk-scss/theme/tab.scss";

//@import "@uk-scss/theme/slidenav.scss";

//@import "@uk-scss/theme/dotnav.scss";

//@import "@uk-scss/theme/thumbnav.scss";

//@import "@uk-scss/theme/iconnav.scss";

//@import "@uk-scss/theme/lightbox.scss";

// Utilities

//@import "@uk-scss/theme/animation.scss";

//@import "@uk-scss/theme/width.scss";

//@import "@uk-scss/theme/height.scss";

//@import "@uk-scss/theme/text.scss";

//@import "@uk-scss/theme/column.scss";

//@import "@uk-scss/theme/background.scss";

//@import "@uk-scss/theme/align.scss";

//@import "@uk-scss/theme/utility.scss";

//@import "@uk-scss/theme/margin.scss";

//@import "@uk-scss/theme/padding.scss";

//@import "@uk-scss/theme/position.scss";

//@import "@uk-scss/theme/transition.scss";

//@import "@uk-scss/theme/inverse.scss";

/* END: Overrides: ./node_modules/uikit/src/scss/theme/_import.scss */

//@import "@uk-scss/theme/components/_import.scss";

* Overrides:

* ./node_modules/uikit/src/scss/components/_import.scss

// Base

@import "@uk-scss/components/variables.scss";

@import "@uk-scss/components/mixin.scss";

@import "@uk-scss/components/base.scss";

// Elements

@import "@uk-scss/components/link.scss";

@import "@uk-scss/components/heading.scss";

@import "@uk-scss/components/divider.scss";

@import "@uk-scss/components/list.scss";

@import "@uk-scss/components/description-list.scss";

@import "@uk-scss/components/table.scss";

@import "@uk-scss/components/icon.scss";

@import "@uk-scss/components/form-range.scss";

@import "@uk-scss/components/form.scss"; // After: Icon, Form Range

@import "@uk-scss/components/button.scss";

@import "@uk-scss/components/progress.scss";

// Layout

@import "@uk-scss/components/section.scss";

@import "@uk-scss/components/container.scss";

@import "@uk-scss/components/tile.scss";

@import "@uk-scss/components/card.scss";

// Common

@import "@uk-scss/components/close.scss"; // After: Icon

@import "@uk-scss/components/spinner.scss"; // After: Icon

@import "@uk-scss/components/totop.scss"; // After: Icon

@import "@uk-scss/components/marker.scss"; // After: Icon

@import "@uk-scss/components/alert.scss"; // After: Close

@import "@uk-scss/components/placeholder.scss";

@import "@uk-scss/components/badge.scss";

@import "@uk-scss/components/label.scss";

@import "@uk-scss/components/overlay.scss"; // After: Icon

@import "@uk-scss/components/article.scss";

@import "@uk-scss/components/comment.scss";

@import "@uk-scss/components/search.scss"; // After: Icon

// JavaScript

@import "@uk-scss/components/accordion.scss";

//@import "@uk-scss/components/drop.scss"; // After: Card

//@import "@uk-scss/components/dropdown.scss"; // After: Card

//@import "@uk-scss/components/modal.scss"; // After: Close

//@import "@uk-scss/components/slideshow.scss";

//@import "@uk-scss/components/slider.scss";

//@import "@uk-scss/components/sticky.scss";

//@import "@uk-scss/components/offcanvas.scss";

//@import "@uk-scss/components/switcher.scss";

//@import "@uk-scss/components/leader.scss";

@import "@uk-scss/components/notification.scss";

//@import "@uk-scss/components/tooltip.scss";

//@import "@uk-scss/components/sortable.scss";

@import "@uk-scss/components/countdown.scss";

// Scrollspy

// Toggle

// Scroll

@import "@uk-scss/components/grid.scss";

// Navs

@import "@uk-scss/components/nav.scss";

@import "@uk-scss/components/navbar.scss"; // After: Card, Grid, Nav, Icon, Search

@import "@uk-scss/components/subnav.scss";

@import "@uk-scss/components/breadcrumb.scss";

@import "@uk-scss/components/pagination.scss";

@import "@uk-scss/components/tab.scss";

@import "@uk-scss/components/slidenav.scss"; // After: Icon

@import "@uk-scss/components/dotnav.scss";

@import "@uk-scss/components/thumbnav.scss";

@import "@uk-scss/components/iconnav.scss";

@import "@uk-scss/components/lightbox.scss"; // After: Close, Slidenav

// Utilities

@import "@uk-scss/components/animation.scss";

@import "@uk-scss/components/width.scss";

@import "@uk-scss/components/height.scss";

@import "@uk-scss/components/text.scss";

@import "@uk-scss/components/column.scss";

@import "@uk-scss/components/cover.scss";

@import "@uk-scss/components/background.scss";

@import "@uk-scss/components/align.scss";

@import "@uk-scss/components/svg.scss";

@import "@uk-scss/components/utility.scss";

@import "@uk-scss/components/flex.scss"; // After: Utility

@import "@uk-scss/components/margin.scss";

@import "@uk-scss/components/padding.scss";

@import "@uk-scss/components/position.scss";

@import "@uk-scss/components/transition.scss";

@import "@uk-scss/components/visibility.scss";

@import "@uk-scss/components/inverse.scss";

// Need to be loaded last

@import "@uk-scss/components/print.scss";

/* END: Overrides: ./node_modules/uikit/src/scss/components/_import.scss */

/* END: Overrides: ./node_modules/uikit/src/scss/uikit-theme.scss */

[Magento 2] Utiliser le source model Yesno pour faire apparaître de manière dynamique et sous condition un champ caché dans un widget custom

17/01/2020 / admin

Nous avons ici deux champs mais l’affichage du second, masqué au chargement du formulaire, est conditionné à l’activation du premier qui est un booléen (true/false -> si « true », alors le second champ est affiché).

<parameter name="show_hidden_field" xsi:type="select" visible="true"
           source_model="Magento\Config\Model\Config\Source\Yesno">
    <label translate="true">Show hidden field</label>
</parameter>
<parameter name="hidden_field" xsi:type="text" required="true" visible="true">
    <label translate="true">Hidden field</label>
    <depends>
        <parameter name="show_hidden_field" value="1" />
    </depends>
    <value>5</value>
</parameter>

<parameter name="show_hidden_field" xsi:type="select" visible="true"

source_model="Magento\Config\Model\Config\Source\Yesno">

<label translate="true">Show hidden field</label>

</parameter>

<label translate="true">Hidden field</label>

</depends>

</parameter>

Cas où l’affichage du champ caché dépend de l’activation de plusieurs autres champs

Pas encore testé, mais vu sur le net et notifié comme fonctionnel (bug fixé dans la 2.3.x).

<parameter name="myfield" xsi:type="text" required="true" visible="true">
      <label translate="true">Example</label>
      <depends>
          <parameter name="dependency_one" value="1"/>
          <parameter name="dependency_two" value="1"/>
      </depends>
</parameter>

<label translate="true">Example</label>

</depends>

</parameter>

[Magento 2] Ajouter un sélecteur d’image ou un champ WYSIWYG dans un widget custom

13/01/2020 / admin

Pour ajouter un sélecteur d’image ou un champ WYSIWYG dans un widget custom dans Magento 2, nous allons utiliser l’extension suivante: Useful widget types for Magento 2 like image selector and wysiwyg text editor (un article de l’auteur ici: Using an Image Selector Parameter for Magento Widgets).

Code source zippé – magento2-widget-parameters-master.

Convention: on part du principe qu’on crée un widget pour le vendor Sodifrance et le module Pdv.

Installation de l’extension magento2-widget-parameters via Composer

Documentation officielle de Magento 2 sur comment installer une extension via composer.

Lancer la commande $ composer require dmatthew/magento2-widget-parameters:1.0.1 à la racine de votre projet Magento 2.
Des warnings vont probablement s’afficher. Ne pas en tenir compte.

./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
  - Installing dmatthew/magento2-widget-parameters (1.0.1): Downloading (100%)
Package container-interop/container-interop is abandoned, you should avoid using it. Use psr/container instead.
Package moontoast/math is abandoned, you should avoid using it. Use brick/math instead.
Package phpunit/phpunit-mock-objects is abandoned, you should avoid using it. No replacement was suggested.
Package zendframework/zend-barcode is abandoned, you should avoid using it. Use laminas/laminas-barcode instead.
Package zendframework/zend-captcha is abandoned, you should avoid using it. Use laminas/laminas-captcha instead.
Package zendframework/zend-code is abandoned, you should avoid using it. Use laminas/laminas-code instead.
Package zendframework/zend-config is abandoned, you should avoid using it. Use laminas/laminas-config instead.
Package zendframework/zend-console is abandoned, you should avoid using it. Use laminas/laminas-console instead.
Package zendframework/zend-crypt is abandoned, you should avoid using it. Use laminas/laminas-crypt instead.
Package zendframework/zend-db is abandoned, you should avoid using it. Use laminas/laminas-db instead.
Package zendframework/zend-di is abandoned, you should avoid using it. Use laminas/laminas-di instead.
Package zendframework/zend-diactoros is abandoned, you should avoid using it. Use laminas/laminas-diactoros instead.
Package zendframework/zend-escaper is abandoned, you should avoid using it. Use laminas/laminas-escaper instead.
Package zendframework/zend-eventmanager is abandoned, you should avoid using it. Use laminas/laminas-eventmanager instead.
Package zendframework/zend-feed is abandoned, you should avoid using it. Use laminas/laminas-feed instead.
Package zendframework/zend-filter is abandoned, you should avoid using it. Use laminas/laminas-filter instead.
Package zendframework/zend-form is abandoned, you should avoid using it. Use laminas/laminas-form instead.
Package zendframework/zend-http is abandoned, you should avoid using it. Use laminas/laminas-http instead.
Package zendframework/zend-hydrator is abandoned, you should avoid using it. Use laminas/laminas-hydrator instead.
Package zendframework/zend-i18n is abandoned, you should avoid using it. Use laminas/laminas-i18n instead.
Package zendframework/zend-inputfilter is abandoned, you should avoid using it. Use laminas/laminas-inputfilter instead.
Package zendframework/zend-json is abandoned, you should avoid using it. Use laminas/laminas-json instead.
Package zendframework/zend-loader is abandoned, you should avoid using it. Use laminas/laminas-loader instead.
Package zendframework/zend-log is abandoned, you should avoid using it. Use laminas/laminas-log instead.
Package zendframework/zend-mail is abandoned, you should avoid using it. Use laminas/laminas-mail instead.
Package zendframework/zend-math is abandoned, you should avoid using it. Use laminas/laminas-math instead.
Package zendframework/zend-mime is abandoned, you should avoid using it. Use laminas/laminas-mime instead.
Package zendframework/zend-modulemanager is abandoned, you should avoid using it. Use laminas/laminas-modulemanager instead.
Package zendframework/zend-mvc is abandoned, you should avoid using it. Use laminas/laminas-mvc instead.
Package zendframework/zend-psr7bridge is abandoned, you should avoid using it. Use laminas/laminas-psr7bridge instead.
Package zendframework/zend-serializer is abandoned, you should avoid using it. Use laminas/laminas-serializer instead.
Package zendframework/zend-server is abandoned, you should avoid using it. Use laminas/laminas-server instead.
Package zendframework/zend-servicemanager is abandoned, you should avoid using it. Use laminas/laminas-servicemanager instead.
Package zendframework/zend-session is abandoned, you should avoid using it. Use laminas/laminas-session instead.
Package zendframework/zend-soap is abandoned, you should avoid using it. Use laminas/laminas-soap instead.
Package zendframework/zend-stdlib is abandoned, you should avoid using it. Use laminas/laminas-stdlib instead.
Package zendframework/zend-text is abandoned, you should avoid using it. Use laminas/laminas-text instead.
Package zendframework/zend-uri is abandoned, you should avoid using it. Use laminas/laminas-uri instead.
Package zendframework/zend-validator is abandoned, you should avoid using it. Use laminas/laminas-validator instead.
Package zendframework/zend-view is abandoned, you should avoid using it. Use laminas/laminas-view instead.
Writing lock file
Generating autoload files

./composer.json has been updated

Loading composer repositories with package information

Updating dependencies (including require-dev)

Package operations: 1 install, 0 updates, 0 removals

- Installing dmatthew/magento2-widget-parameters (1.0.1): Downloading (100%)

Package container-interop/container-interop is abandoned, you should avoid using it. Use psr/container instead.

Package moontoast/math is abandoned, you should avoid using it. Use brick/math instead.

Package phpunit/phpunit-mock-objects is abandoned, you should avoid using it. No replacement was suggested.

Package zendframework/zend-barcode is abandoned, you should avoid using it. Use laminas/laminas-barcode instead.

Package zendframework/zend-captcha is abandoned, you should avoid using it. Use laminas/laminas-captcha instead.

Package zendframework/zend-code is abandoned, you should avoid using it. Use laminas/laminas-code instead.

Package zendframework/zend-config is abandoned, you should avoid using it. Use laminas/laminas-config instead.

Package zendframework/zend-console is abandoned, you should avoid using it. Use laminas/laminas-console instead.

Package zendframework/zend-crypt is abandoned, you should avoid using it. Use laminas/laminas-crypt instead.

Package zendframework/zend-db is abandoned, you should avoid using it. Use laminas/laminas-db instead.

Package zendframework/zend-di is abandoned, you should avoid using it. Use laminas/laminas-di instead.

Package zendframework/zend-diactoros is abandoned, you should avoid using it. Use laminas/laminas-diactoros instead.

Package zendframework/zend-escaper is abandoned, you should avoid using it. Use laminas/laminas-escaper instead.

Package zendframework/zend-eventmanager is abandoned, you should avoid using it. Use laminas/laminas-eventmanager instead.

Package zendframework/zend-feed is abandoned, you should avoid using it. Use laminas/laminas-feed instead.

Package zendframework/zend-filter is abandoned, you should avoid using it. Use laminas/laminas-filter instead.

Package zendframework/zend-form is abandoned, you should avoid using it. Use laminas/laminas-form instead.

Package zendframework/zend-http is abandoned, you should avoid using it. Use laminas/laminas-http instead.

Package zendframework/zend-hydrator is abandoned, you should avoid using it. Use laminas/laminas-hydrator instead.

Package zendframework/zend-i18n is abandoned, you should avoid using it. Use laminas/laminas-i18n instead.

Package zendframework/zend-inputfilter is abandoned, you should avoid using it. Use laminas/laminas-inputfilter instead.

Package zendframework/zend-json is abandoned, you should avoid using it. Use laminas/laminas-json instead.

Package zendframework/zend-loader is abandoned, you should avoid using it. Use laminas/laminas-loader instead.

Package zendframework/zend-log is abandoned, you should avoid using it. Use laminas/laminas-log instead.

Package zendframework/zend-mail is abandoned, you should avoid using it. Use laminas/laminas-mail instead.

Package zendframework/zend-math is abandoned, you should avoid using it. Use laminas/laminas-math instead.

Package zendframework/zend-mime is abandoned, you should avoid using it. Use laminas/laminas-mime instead.

Package zendframework/zend-modulemanager is abandoned, you should avoid using it. Use laminas/laminas-modulemanager instead.

Package zendframework/zend-mvc is abandoned, you should avoid using it. Use laminas/laminas-mvc instead.

Package zendframework/zend-psr7bridge is abandoned, you should avoid using it. Use laminas/laminas-psr7bridge instead.

Package zendframework/zend-serializer is abandoned, you should avoid using it. Use laminas/laminas-serializer instead.

Package zendframework/zend-server is abandoned, you should avoid using it. Use laminas/laminas-server instead.

Package zendframework/zend-servicemanager is abandoned, you should avoid using it. Use laminas/laminas-servicemanager instead.

Package zendframework/zend-session is abandoned, you should avoid using it. Use laminas/laminas-session instead.

Package zendframework/zend-soap is abandoned, you should avoid using it. Use laminas/laminas-soap instead.

Package zendframework/zend-stdlib is abandoned, you should avoid using it. Use laminas/laminas-stdlib instead.

Package zendframework/zend-text is abandoned, you should avoid using it. Use laminas/laminas-text instead.

Package zendframework/zend-uri is abandoned, you should avoid using it. Use laminas/laminas-uri instead.

Package zendframework/zend-validator is abandoned, you should avoid using it. Use laminas/laminas-validator instead.

Package zendframework/zend-view is abandoned, you should avoid using it. Use laminas/laminas-view instead.

Writing lock file

Generating autoload files

app/code/Sodifrance/Pdv/etc/widget.xml

Nous allons déclarer un widget contenant 3 paramètres:

un titre
une image issue de la « médiathèque » de Magento 2
un champ WYSIWYG (qui permet d’utiliser du code HTML pour la mise en page, ou d’inclure un bloc statique)

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
    <widget class="Sodifrance\Pdv\Block\Widget\Tab" id="tab_widget">
        <label>Tab Widget</label>
        <description>Tab Widget for Magento 2</description>
        <parameters>
            <parameter name="title" xsi:type="text" required="true" visible="true" sort_order="10">
                <label>Label</label>
            </parameter>
            <parameter xsi:type="block" name="background_image" visible="true" sort_order="10">
                <label translate="true">Image</label>
                <block class="Dmatthew\WidgetParameters\Block\Adminhtml\Widget\Type\ImageChooser">
                    <data>
                        <item name="button" xsi:type="array">
                            <item name="open" xsi:type="string">Choose Image...</item>
                        </item>
                    </data>
                </block>
            </parameter>
            <parameter xsi:type="block" name="body_text" visible="true" sort_order="10">
                <label translate="true">Body Text</label>
                <block class="Dmatthew\WidgetParameters\Block\Adminhtml\Widget\Type\Wysiwyg" />
            </parameter>
        </parameters>
    </widget>
</widgets>

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">

<label>Tab Widget</label>

<description>Tab Widget for Magento 2</description>

<label>Label</label>

</parameter>

<label translate="true">Image</label>

<data>

<item name="open" xsi:type="string">Choose Image...</item>

</item>

</data>

</block>

</parameter>

</parameter>

</parameters>

</widget>

</widgets>

app/code/Sodifrance/Pdv/Block/Widget/Tab.php

Il a fallu créer une fonction pour permettre de récupérer l’URL de l’image uploadée.

<?php
namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;
use Magento\Widget\Block\BlockInterface;

class Tab extends Template implements BlockInterface {

    protected $_template = "widget/tab.phtml";

    /**
     * @var \Magento\Cms\Helper\Wysiwyg\Images
     */
    protected $helper;

    public function __construct(Template\Context $context, \Magento\Cms\Helper\Wysiwyg\Images $helper, array $data = [])
    {
        $this->helper = $helper;
        parent::__construct($context, $data);
    }

    public function getTabWidgetMediaUrl()
    {
        return
            $this->helper->getBaseUrl() .
            $this->getData('background_image');
    }
}

<?php

namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;

use Magento\Widget\Block\BlockInterface;

class Tab extends Template implements BlockInterface {

protected $_template = "widget/tab.phtml";

/**

* @var \Magento\Cms\Helper\Wysiwyg\Images

protected $helper;

public function __construct(Template\Context $context, \Magento\Cms\Helper\Wysiwyg\Images $helper, array $data = [])

{

$this->helper = $helper;

parent::__construct($context, $data);

}

public function getTabWidgetMediaUrl()

{

return

$this->helper->getBaseUrl() .

$this->getData('background_image');

}

app/code/Sodifrance/Pdv/view/frontend/templates/widget/tab.phtml

Le template PHTML.

<?php
/** \Sodifrance\Pdv\Block\Widget\Tab $block */
?>

<div class="widget widget-tab">
    <div class="widget-tab-label cms-blockHeading-2">
        <h2 class="heading">
            <?= $block->escapeHtml($block->getData('title')) ?>
        </h2>
    </div>
    <div class="widget-tab-content">
        <div class="widget-tab-left-col">
            <img src="<?= $block->getTabWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-tab-image" />
        </div>
        <div class="widget-tab-right-col">
            <?= $block->getData('body_text') ?>
        </div>
    </div>
</div>

<?php

/** \Sodifrance\Pdv\Block\Widget\Tab $block */

<?= $block->escapeHtml($block->getData('title')) ?>

</h2>

</div>

<img src="<?= $block->getTabWidgetMediaUrl() ?>" alt="*" class="img-fluid widget-tab-image" />

</div>

<?= $block->getData('body_text') ?>

</div>

Flusher les caches:

$ n98-magerun2 cache:flush

1	$ n98-magerun2 cache:flush

Si problèmes…

Voir aussi: [Magento 2] Créer un widget custom et l’utiliser pour afficher un bloc statique dans une catégorie unique du catalogue.

[Magento 2] Créer un widget custom et l’utiliser pour afficher un bloc statique dans une catégorie unique du catalogue

10/01/2020 / admin

Créer un widget custom dans Magento 2 peut être utile, notamment car cette solution permet de placer un bloc statique de manière beaucoup plus sélective (on peut cibler une catégorie unique du catalogue par exemple) et depuis l’interface d’admin.

Dans ce billet:

Je me suis inspiré de la doc officielle et d’un autre tuto pour arriver à mes fins, la doc officielle étant incomplète et les exemples de code erronés!

On part du principe qu’on crée un widget pour le vendor Sodifrance et le module Pdv.

Initialiser le widget

app/code/Sodifrance/Pdv/registration.php

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Sodifrance_Pdv',
    __DIR__
);

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Sodifrance_Pdv',

__DIR__

);

app/code/Sodifrance/Pdv/etc/widget.xml

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
    <widget class="Sodifrance\Pdv\Block\Widget\Test" id="pdv_test_widget">
        <label>Test Widget</label>
        <description>This is a test widget!!!</description>
        <parameters>
            <parameter name="title" xsi:type="text" required="true" visible="true" sort_order="10">
                <label>Label</label>
            </parameter>
            <parameter name="size" xsi:type="select" visible="true" required="true" sort_order="20">
                <label translate="true">Size</label>
                <options>
                    <option name="s" value="S">
                        <label>S</label>
                    </option>
                    <option name="m" value="M" selected="true">
                        <label>M</label>
                    </option>
                    <option name="l" value="L">
                        <label>L</label>
                    </option>
                </options>
            </parameter>
        </parameters>
    </widget>
</widgets>

<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">

<label>Test Widget</label>

<description>This is a test widget!!!</description>

<label>Label</label>

</parameter>

</option>

</option>

</option>

</options>

</parameter>

</parameters>

</widget>

</widgets>

Créer un template pour le widget

app/code/Sodifrance/Pdv/view/frontend/templates/widget/test.phtml

<?php
/** \Sodifrance\Pdv\Block\Widget\Test $block */
?>
<h3><?= $block->escapeHtml($block->getData('title')) ?></h3>
<h3><?= $block->escapeHtml(__('Size:')) ?> <?= $block->escapeHtml($block->getData('size')) ?></h3>

<?php

/** \Sodifrance\Pdv\Block\Widget\Test $block */

<h3><?= $block->escapeHtml($block->getData('title')) ?></h3>

<h3><?= $block->escapeHtml(__('Size:')) ?> <?= $block->escapeHtml($block->getData('size')) ?></h3>

Créer un block pour le widget

app/code/Sodifrance/Pdv/Block/Widget/Test.php

<?php
namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;
use Magento\Widget\Block\BlockInterface;

class Test extends Template implements BlockInterface {

    protected $_template = "widget/test.phtml";

}

<?php

namespace Sodifrance\Pdv\Block\Widget;

use Magento\Framework\View\Element\Template;

use Magento\Widget\Block\BlockInterface;

class Test extends Template implements BlockInterface {

protected $_template = "widget/test.phtml";

}

Ajouter une dépendance au module Magento_Widget dans le fichier `module.xml`

app/code/Sodifrance/Pdv/etc/module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Sodifrance_Pdv" setup_version="1.0.0">
        <sequence>
            <module name="MGS_ThemeSettings" />
            <module name="Magento_Widget" />
        </sequence>
    </module>
</config>

<?xml version="1.0"?>

</sequence>

</module>

</config>

Commandes à exécuter

Appliquer la dépendance de module déclarée dans le fichier module.xml:

$ n98-magerun2 module:disable Sodifrance_Pdv
$ n98-magerun2 module:enable Sodifrance_Pdv

1 2	$ n98-magerun2 module:disable Sodifrance_Pdv $ n98-magerun2 module:enable Sodifrance_Pdv

Flusher les caches:

$ n98-magerun2 cache:flush

1	$ n98-magerun2 cache:flush

Accès BO à votre widget custom

Contenu > Widgets > Ajouter un widget
Choisir le type de widget dans la liste déroulante: « Test Widget »

Pour afficher un widget dans une seule catégorie du catalogue:

Contenu > Widgets > Ajouter un widget
Choisir le type de widget et le thème de design
Remplir les champs obligatoires de la section « Propriétés du front office »
Dans la section « Mises à jour d’agencements » > Ajouter une mise à jour d’agencements
Display on: catégorie ancrée
Catégories: Spécifique à Categories
Cliquer sur l’icône « Ouvrir le sélecteur »
Déplier l’arbre de catégories/sous-catégories et cocher la ou les catégories dans laquelle le widget doit s’afficher; il ne s’affichera pas dans les autres

[Magento 2] Inclure un bloc statique depuis un champ WYSIWYG (nouvelle fenêtre).

Une liste de ressources en ligne intéressantes sur le sujet

Dépôts Git de démonstration, proof of concepts, etc …

Magento 2: Widgets – This module is to demonstrate the different fields available for Magento 2 widgets. The idea is to use this as a base or reference for creating your own widgets. There is an example widget provided which has all the possible field types available.

Tutoriels

inchoo.net – Magento 2 custom widget. Now we will see how we can create a custom one, or even better, how to extend the core one. For this example I picked default catalog product listing widget that I will extend with sorting fields for better customization of this widget.

[Magento 2] Comment inclure et utiliser un fichier JS custom avec requireJS

29/10/2019 / admin

Source: How to include and use custom js file with require js in magento2.

Source: Four Ways to Add JavaScript to Magento 2.

En-dehors d’un thème, en créant un module

Se référer à la documentation officielle de Magento 2 pour voir comment créer un nouveau module. Dans mon exemple, le vendor s’appelle Naked et le module s’appelle HelloWorld.

Dans app/code/Naked/HelloWorld/ créer une arborescence de dossiers et les trois fichiers suivants:

view/frontend/requirejs-config.js
view/frontend/web/js/hello-world.js
view/frontend/web/js/methods.js

view/frontend/requirejs-config.js

var config = {

    // You can also set the map property and define the prefixes for various modules.
    // In future, we can use these prefixes to connect the required JS modules in other modules.
    map: {
        '*': {
            helloWorld: 'Naked_HelloWorld/js/hello-world',
            methods: 'Naked_HelloWorld/js/methods',
        }
    },

    // In this case, the scripts we have connected will work on all pages of the module.
    // Usually, some third-party libraries are connected in this way.
    deps: [
        'Naked_HelloWorld/js/hello-world',
    ]
};

var config = {

// You can also set the map property and define the prefixes for various modules.

// In future, we can use these prefixes to connect the required JS modules in other modules.

map: {

'*': {

helloWorld: 'Naked_HelloWorld/js/hello-world',

methods: 'Naked_HelloWorld/js/methods',

}

// In this case, the scripts we have connected will work on all pages of the module.

// Usually, some third-party libraries are connected in this way.

deps: [

'Naked_HelloWorld/js/hello-world',

]

};

Les scripts déclarés sous la variable deps vont fonctionner immédiatement et sur toutes les pages du site. Inutile d’initialiser quoi que ce soit dans un fichier *.phtml.

view/frontend/web/js/hello-world.js

define(['jquery', 'methods'], function($, methods) {
    "use strict";

    console.log('hello world!');

    $('a.logo').on('click', function(e){
        e.preventDefault();
        methods.showAlert('Logo clicked!');
    });
});

define(['jquery', 'methods'], function($, methods) {

"use strict";

console.log('hello world!');

$('a.logo').on('click', function(e){

e.preventDefault();

methods.showAlert('Logo clicked!');

});

view/frontend/web/js/methods.js

define(['jquery'], function($) {

    var methods = {};

    methods.showAlert = function(arg) {
        alert(arg);
    }

    return methods;

});

define(['jquery'], function($) {

var methods = {};

methods.showAlert = function(arg) {

alert(arg);

}

return methods;

});

[NPM][Gulp] Ajouter un custom build de Modernizr à un projet

31/10/2017 / admin

Ajouter les sources de Modernizr comme dépendances NPM

Source: Modernizr documentation > Downloading Modernizr > Command Line Config.

npm install --save-dev modernizr

1	npm install --save-dev modernizr

Installer également le paquet gulp-modernizr.

npm install --save-dev gulp-modernizr

1	npm install --save-dev gulp-modernizr

Ce plugin permet tout un tas de paramétrages détaillés ici. Pour l’heure, nous exploiterons uniquement les champs options et tests.

gulpconf.json

{
  "plugins": {
    "modernizr": {
      "options" : [
        "setClasses"
      ],
      "tests" : [
        "touchevents"
      ]
    }
  }, 
}

{

"plugins": {

"modernizr": {

"options" : [

"setClasses"

"tests" : [

"touchevents"

]

}

Ici je créer un custom build avec uniquement la feature touchevents à déclarer sous tests.

Connaître les options requises en fonction des features qu’on souhaite embarquer

Pour vous aider à savoir quelles sont les options requises en fonction des features que vous souhaitez utiliser, vous pouvez créer votre custom build via l’interface en ligne disponible sur modernizr.com.

Choisissez par exemple la feature touchevents et cliquez sur BUILD (bouton rose en haut à droite). Une modale apparaît. Sous Grunt config cliquez sur « Copy to clipboard ». Le code suivant apparaît:

{
  "crawl": false,
  "customTests": [],
  "dest": "/PATH/TO/modernizr-output.js",
  "tests": [
    "touchevents"
  ],
  "options": [
    "setClasses"
  ],
  "uglify": true
}

{

"crawl": false,

"customTests": [],

"dest": "/PATH/TO/modernizr-output.js",

"tests": [

"touchevents"

"options": [

"setClasses"

"uglify": true

}

Les champs options et tests révèlent les pré-requis à renseigner dans la configuration de votre plugin Gulp.

gulpfile.js

Déclarer gulp-modernizr:

var modernizr = require('gulp-modernizr');

1	var modernizr = require('gulp-modernizr');

Puis initialiser la tâche de build:

gulp.task('build:modernizr', function() {
  gulp.src('./js/*.js')
    .pipe(modernizr('modernizr-custom.js', config.plugins.modernizr))
    .pipe(gulp.dest(config.paths.scripts.dest))
});

gulp.task('build:modernizr', function() {

gulp.src('./js/*.js')

.pipe(modernizr('modernizr-custom.js', config.plugins.modernizr))

.pipe(gulp.dest(config.paths.scripts.dest))

});

Méthode préférée de création d’un bundle des composants du framework front-end UIkit v3 avec Webpack

La configuration de Webpack

Fichier webpack.config.js

Le bundle à la carte des styles (format SCSS)

Fichier assets/styles/app.scss

Fichier assets/styles/_uikit-explicit-pieces.scss

Edit: l’utilisation de PurgeCSS avec Webpack rend le reste de la partie SCSS de cet article totalement OBSOLèTE!

Fichier assets/uikit/src/scss/theme/_import.scss

Fichier assets/uikit/src/scss/components/_import.scss

Les fichiers JS

Fichier assets/app.js

Fichier assets/uikit/src/js/core/index.js

Fichier assets/uikit/src/js/components/index.js

Les icônes

Structure des dossiers (à respecter)

Fichier assets/uikit/build/util.js

Petit récapitulatif de l’arborescence attendue

Le script bash

Nouvelle méthode (au 04/05/2021):

Méthode précédente (dépréciée):

Quelques chiffres suite à mes tests

Caveats connus!

Méthode alternative (attention: limitations connues au niveau des icônes)

Diagnostique des erreurs:

Fichiers impliqués

Fichier assets/app.js

Fichier webpack.config.js:

Bundle Javascript – Fichier assets/uikit-explicit-pieces.js:

Bundle Styles – Fichier: uikit-explicit-pieces.scss:

Cas où l’affichage du champ caché dépend de l’activation de plusieurs autres champs

Installation de l’extension magento2-widget-parameters via Composer

app/code/Sodifrance/Pdv/etc/widget.xml

app/code/Sodifrance/Pdv/Block/Widget/Tab.php

app/code/Sodifrance/Pdv/view/frontend/templates/widget/tab.phtml

Flusher les caches:

Si problèmes…

Créer un widget custom dans Magento 2

Initialiser le widget

Créer un template pour le widget

Créer un block pour le widget

Ajouter une dépendance au module Magento_Widget dans le fichier module.xml

Commandes à exécuter

Accès BO à votre widget custom

Pour afficher un widget dans une seule catégorie du catalogue:

Ajouter un bloc statique dans un widget custom Magento 2

Une liste de ressources en ligne intéressantes sur le sujet

Dépôts Git de démonstration, proof of concepts, etc …

Tutoriels

En-dehors d’un thème, en créant un module

view/frontend/requirejs-config.js

view/frontend/web/js/hello-world.js

view/frontend/web/js/methods.js

Ajouter les sources de Modernizr comme dépendances NPM

gulpconf.json

Connaître les options requises en fonction des features qu’on souhaite embarquer

gulpfile.js

Fichier `webpack.config.js`

Fichier `assets/styles/app.scss`

Fichier `assets/styles/_uikit-explicit-pieces.scss`

Fichier `assets/uikit/src/scss/theme/_import.scss`

Fichier `assets/uikit/src/scss/components/_import.scss`

Fichier `assets/app.js`

Fichier `assets/uikit/src/js/core/index.js`

Fichier `assets/uikit/src/js/components/index.js`

Fichier `assets/uikit/build/util.js`

Fichier `assets/app.js`

Fichier `webpack.config.js`:

Bundle Javascript – Fichier `assets/uikit-explicit-pieces.js`:

Bundle Styles – Fichier: `uikit-explicit-pieces.scss`:

Ajouter une dépendance au module Magento_Widget dans le fichier `module.xml`