Gaufre

Installazione

Assicurarsi di avere installato sulla macchina NodeJS e NPM. Dopodiche sarà sufficiente eseguire da terminale il comando: npm i @webtekteam/gaufre o yarn add @webtekteam/gaufre. Verrà scaricato ed installato come un normalissimo pacchetto di node_modules.

Utilizzo all'interno di un progetto

La seguente libreria è pensata come un insieme di strumenti, divisi a livello "funzionale", principalmente SCSS (perlopiù mixins e utility classes) da poter importare a seconda delle esigenze; sulla falsa riga di come accade per il pacchetto sorgente di bootstrap, che permette l'importazione dei singoli file scss nei quali sono definiti "grid system, tabs, buttons ecc..". Esempio.

Per fornire un esempio, volendo utilizzare una collezione di mixin per gestire le mediaqueries, sarà sufficiente importare il file desiderato dalla cartella node_modules. Supponendo di avere un workflow di compilazione dell'scss tramite webpack/gulp o affini e di avere un riferimento a node_modules tramite ~, aggiungere questa riga nel file scss in cui è richiesta questa utility: @import ~@webtekteam/gaufre/scss/media-queries/non-printing; e utilizzare poi il/i mixin/s contenuto/i in questo file.

E così via si potrà attingere a diverse utility o includerle tutte qualora fosse necessario.

Compilazione

Per i file scss è importante suddividere i componenti in printing.scss e non-printing.scss con il secondo che conterrà solo mixin e function senza andare quindi a stampare nulla nell'output.

Informazioni genereriche sulle utility

TODO