Ga naar de inhoud

Assets verwerken

Minificatie

Blockstudio kan alle CSS- en JS-bestanden in een blok automatisch minificeren.

Gecompileerde bestanden worden opgeslagen in de map _dist van het blok en aan de wachtrij toegevoegd zodra een blok wordt gebruikt. Wanneer het bronbestand wordt bijgewerkt, controleert Blockstudio of er een gecompileerd bestand met die tijdstempel bestaat; zo niet, dan wordt het aangemaakt.

Hiervoor wordt de bibliotheek minify gebruikt.

Minificatie kan worden ingeschakeld met de instelling assets/minify:

PHP
add_filter('blockstudio/settings/assets/minify/css', function() {
  return true;
});

add_filter('blockstudio/settings/assets/minify/js', function() {
  return true;
});

SCSS

Als je je stijlen liever in SCSS schrijft, kun je de verwerking van SCSS inschakelen:

PHP
add_filter('blockstudio/settings/assets/process/scss', function() {
  return true;
});

Hierdoor wordt de verwerking van SCSS ingeschakeld voor .css-bestanden.

Je kunt ook de extensie .scss gebruiken; stijlen worden dan automatisch verwerkt, zelfs als de bovenstaande instelling niet is ingesteld op true.

Importpaden

Bij gebruik van SCSS kun je andere SCSS-bestanden importeren. Imports zijn relatief aan het bestand van waaruit ze worden geïmporteerd.

CSS
@import "modules.scss";

Daarnaast kun je aangepaste importpaden definiëren met het filter blockstudio/assets/process/scss/import_paths, zodat bestanden uit andere mappen kunnen worden geïmporteerd zonder een mappenstructuur op te geven.

Bij imports kan de extensie .scss worden weggelaten; ook gedeeltelijke paden zoals _tokens.scss of het _index.scss-bestand van een map worden gevonden.

PHP
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
  $paths[] = get_template_directory() . '/scss';
  return $paths;
});

Voorafgaande code

Als je gedeelde functies, variabelen, mixins of hulpprogramma’s van Sass beschikbaar wilt hebben in elk SCSS-bestand, kun je vóór de compilatie een globale prelude toevoegen.

Dit is handig voor frameworks zoals Bootstrap, waar je toegang wilt hebben tot gedeelde mixins, zoals breakpoints, zonder imports in elk blokasset te herhalen.

PHP
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
  return '@import "functions";' . "\n"
    . '@import "variables";' . "\n"
    . '@import "mixins";';
}, 10, 3);

In combinatie met blockstudio/assets/process/scss/import_paths maakt dit het oppervlak van Sass beschikbaar voor elk gecompileerd bestand.

Blokassets worden opnieuw gecompileerd wanneer de wijzigingstijd van een afhankelijkheid verandert, ook van bestanden die door andere partiële bestanden worden geïmporteerd. Blockstudio volgt lokale afhankelijkheden van @import, @use en @forward, inclusief prelude-afhankelijkheden en ingestelde importpaden. Gedeelde afhankelijkheden worden één keer bijgehouden en cycli kunnen de ontdekking niet in een lus laten vastlopen. Deze bestanden worden ook opgenomen in de controlelijst van de runtimecache.

Als je bijvoorbeeld mixins/_wysiwyg.scss bewerkt, wordt global-styles.scss opnieuw gecompileerd wanneer het scss/_wysiwyg.scss importeert, dat op zijn beurt die mixin importeert. Je hoeft het invoerbestand niet aan te passen om wijzigingen door te voeren. Ingebouwde modules van Sass en externe imports zijn uitgesloten van de lokale afhankelijkheidsgrafiek.

ES-modules

Alle scripts (inline en standaard) in Blockstudio worden standaard geladen met type="module" toegepast. Je kunt daardoor de importsyntaxis gebruiken in de scripts van je blokken, zonder extra configuratie.

Opmerking

Lees voor meer informatie over ES-modules de webdocumentatie van MDN.

Stel je voor dat de volgende code in een script.js staat:

JavaScript
import { h, render } from "https://esm.sh/preact@10.15.1";
import htm from "https://esm.sh/htm@3.1.1";
import confetti from "https://esm.sh/canvas-confetti@1.6.0";

const html = htm.bind(h);

function App(props) {
  confetti();
  return html`<h1>Hello ${props.name}!</h1>`;
}

render(
  html`<${App} name="Hello from Preact!" />`,
  document.querySelector("#element")
);

Met het bovenstaande voorbeeld wordt een component gemaakt met Preact, waarbij alle benodigde componenten en functies worden geïmporteerd uit een ESM-compatibele CDN, in dit geval esm.sh. Deze aanpak is op zich prima, maar heeft als nadeel dat de benodigde assets van een externe site moeten worden opgehaald. Als de CDN niet beschikbaar is, kunnen scripts daardoor niet meer werken.

Blockstudio biedt een handige manier om ES-modules naar het blok te downloaden, zodat je in productie geen externe ESM-CDN’s nodig hebt.

Configuratie

Gebruik de prefix npm:, gevolgd door de pakketnaam en versie, om een module naar de blokmap te downloaden:

JavaScript
import { h, render } from "npm:preact@10.15.1";
import htm from "npm:htm@3.1.1";
import confetti from "npm:canvas-confetti@1.6.0";

Deze syntaxis volgt de conventie voor Deno’s npmspecifier.

Opmerking

De verouderde prefix blockstudio/ (e.g., blockstudio/preact@10.15.1) wordt nog steeds ondersteund voor achterwaartse compatibiliteit, maar voor nieuwe projecten raden we aan de prefix npm: te gebruiken. Raadpleeg de migratiehandleiding voor meer informatie.

Blockstudio controleert gewijzigde .js-bestanden automatisch op imports en downloadt ze naar de lokale blokmap. De gedownloade bestanden worden in een map modules in de blokmap geplaatst.

Bij het opslaan wordt het scriptbestand herschreven zodat de lokaal gehoste module wordt gebruikt:

JavaScript
import { h, render } from "./modules/preact/10.15.1.js";
import htm from "./modules/htm/10.15.1.js";
import confetti from "./modules/canvas-confetti/1.6.0.js";

In de editor wordt bij het bekijken van een voorbeeld en werken aan het blok nog steeds de URL CDN gebruikt (Blockstudio gebruikt esm.sh).

Aandachtspunten

Versie

Normaal gesproken kun je modules vanaf CDN’s gebruiken zonder versienummer. In dat geval wordt altijd de nieuwste versie gebruikt. Omdat Blockstudio geen gegevens in de database opslaat, is bij het gebruik van modules een versienummer vereist.

Dezelfde modules

Modules zijn gekoppeld aan hun blok. Ook als je dezelfde module met hetzelfde versienummer in meerdere blokken gebruikt, downloadt Blockstudio de aangevraagde module toch naar het blok. Dit is vooral bedoeld om blokken zelfstandige eenheden te laten zijn die gemakkelijk met andere installaties of sites kunnen worden gedeeld.

Bovendien wordt dezelfde module twee keer aangevraagd als beide blokken op een pagina staan. Dit probleem kun je oplossen door script-inline.js te gebruiken in plaats van het bestand script.js. Blockstudio herschrijft elke import zodat deze verwijst naar de locatie van de eerste instantie van de module, als de naam en het versienummer hetzelfde zijn.

CSS-loader

Je kunt ook CSS-bestanden importeren met dezelfde syntaxis als hierboven.

JavaScript
import "npm:swiper@11.0.0/swiper.min.css";

Het bestand CSS wordt naar de map modules gedownload en automatisch aan de wachtrij toegevoegd zodra het blok wordt gebruikt. Zolang de versie hetzelfde is, wordt slechts één versie van het bestand CSS aan de wachtrij toegevoegd, ook als het in meerdere blokken voorkomt.