Zum Inhalt springen

Assets verarbeiten

Minimierung

Blockstudio kann alle CSS- und JS-Dateien in einem Block automatisch minimieren.

Kompilierte Dateien werden im Ordner _dist des Blocks gespeichert und bei dessen Verwendung in die Warteschlange eingereiht. Wird die Quelldatei aktualisiert, prüft Blockstudio, ob eine kompilierte Datei mit diesem Zeitstempel vorhanden ist. Falls nicht, wird sie erstellt.

Dafür wird die Bibliothek minify verwendet.

Die Minimierung lässt sich mit der Einstellung assets/minify aktivieren:

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

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

SCSS

Wenn du deine Styles lieber in SCSS schreibst, kannst du die Verarbeitung von SCSS aktivieren:

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

Dadurch wird die Verarbeitung von SCSS für .css-Dateien aktiviert.

Alternativ kannst du die Erweiterung .scss verwenden. Dann werden Styles automatisch verarbeitet, auch wenn die obige Einstellung nicht auf true gesetzt ist.

Importpfade

Bei Verwendung von SCSS kannst du weitere SCSS-Dateien importieren. Die Importpfade beziehen sich auf die Datei, aus der importiert wird.

CSS
@import "modules.scss";

Außerdem kannst du mit dem Filter blockstudio/assets/process/scss/import_paths eigene Importpfade festlegen. So lassen sich Dateien aus anderen Verzeichnissen importieren, ohne eine Ordnerstruktur anzugeben.

Bei Imports kann die Dateiendung .scss weggelassen werden; auch Partials wie _tokens.scss oder die _index.scss eines Verzeichnisses werden aufgelöst.

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

Präambel

Wenn du gemeinsame Sass-Funktionen, Variablen, Mixins oder Hilfsprogramme in jeder SCSS-Datei verfügbar machen möchtest, kannst du vor der Kompilierung eine globale Präambel voranstellen.

Das ist nützlich bei Frameworks wie Bootstrap, wenn du gemeinsame Mixins wie Breakpoints nutzen möchtest, ohne die Imports in jedem Block-Asset zu wiederholen.

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

Zusammen mit blockstudio/assets/process/scss/import_paths stellt dies die referenzierten Sass-Elemente in jeder kompilierten Datei bereit.

Block-Assets werden neu kompiliert, wenn sich der Änderungszeitpunkt einer Abhängigkeit ändert, auch bei Dateien, die von anderen Partials importiert werden. Blockstudio verfolgt lokale Abhängigkeiten von @import, @use und @forward, einschließlich Präambel-Abhängigkeiten und konfigurierten Importpfaden. Gemeinsam genutzte Abhängigkeiten werden nur einmal erfasst, und Zyklen können die Erkennung nicht in eine Endlosschleife führen. Diese Dateien werden außerdem in die Liste der zur Laufzeit überwachten Cache-Dateien aufgenommen.

Wird zum Beispiel mixins/_wysiwyg.scss bearbeitet, wird global-styles.scss neu kompiliert, wenn die Datei scss/_wysiwyg.scss importiert, die wiederum dieses Mixin importiert. Änderungen erfordern keine Anpassung der Einstiegsdatei. In Sass integrierte Module und Remote-Imports sind nicht Teil des lokalen Abhängigkeitsgraphen.

ES-Module

Alle Skripte (Inline- und Standardskripte) in Blockstudio werden standardmäßig mit type="module" versehen. Dadurch kannst du die Import-Syntax für die Skripte deiner Blöcke ohne zusätzliche Einrichtung verwenden.

Hinweis

Eine ausführlichere Einführung in ES-Module findest du in der MDN-Webdokumentation.

Stell dir folgenden Code in einem script.js vor:

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")
);

Das obige Beispiel erstellt eine Komponente mit Preact und importiert alle benötigten Komponenten und Funktionen aus einem ESM-kompatiblen CDN, in diesem Fall esm.sh. An diesem Ansatz ist nichts auszusetzen. Allerdings müssen die benötigten Assets von einer externen Website geladen werden, sodass Skripte ausfallen können, wenn der CDN nicht erreichbar ist.

Blockstudio bietet eine praktische Möglichkeit, ES-Module in den Block herunterzuladen. So sind während des Produktivbetriebs keine externen ESM-CDNs erforderlich.

Einrichtung

Um ein Modul in dein Blockverzeichnis herunterzuladen, verwende den Präfix npm: gefolgt vom Paketnamen und der Version:

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";

Diese Syntax entspricht der Konvention für Deno-npm-Bezeichner.

Hinweis

Der veraltete Präfix blockstudio/ (e.g., blockstudio/preact@10.15.1) wird aus Gründen der Abwärtskompatibilität weiterhin unterstützt. Für neue Projekte empfehlen wir jedoch den Präfix npm:. Einzelheiten findest du in der Migrationsanleitung.

Blockstudio prüft geänderte .js-Dateien automatisch auf Imports und lädt diese in das lokale Blockverzeichnis herunter. Die heruntergeladenen Dateien werden in einem Ordner modules im Blockverzeichnis abgelegt.

Beim Speichern wird die Skriptdatei umgeschrieben, damit das lokal gehostete Modul verwendet wird:

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";

Im Editor wird beim Anzeigen der Vorschau und Bearbeiten des Blocks weiterhin die CDN-URL verwendet (Blockstudio verwendet esm.sh).

Einschränkungen

Version

Normalerweise lassen sich Module von CDNs auch ohne Versionsnummer verwenden. In diesem Fall wird immer die neueste Version genutzt. Da Blockstudio keine Informationen in der Datenbank speichert, ist bei der Verwendung von Modulen eine Versionsnummer erforderlich.

Gleiche Module

Module sind auf ihre jeweiligen Blöcke beschränkt. Selbst wenn du dasselbe Modul mit derselben Versionsnummer in mehreren Blöcken verwendest, lädt Blockstudio das angeforderte Modul weiterhin in den jeweiligen Block herunter. Das liegt vor allem daran, dass Blöcke eigenständige Einheiten sein sollen, die sich leicht mit anderen Installationen oder Websites teilen lassen.

Außerdem wird dasselbe Modul zweimal angefordert, wenn beide Blöcke auf einer Seite vorhanden sind. Dieses Problem lässt sich lösen, indem du script-inline.js statt der Datei script.js verwendest. Blockstudio schreibt jeden Import so um, dass er auf den Speicherort des ersten Vorkommens des Moduls verweist, sofern Name und Versionsnummer übereinstimmen.

CSS Loader

Du kannst auch CSS-Dateien mit derselben Syntax wie oben importieren.

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

Die Datei CSS wird in den Ordner modules heruntergeladen und bei Verwendung des Blocks automatisch in die Warteschlange eingereiht. Solange die Version übereinstimmt, wird nur eine einzige Version der Datei CSS in die Warteschlange eingereiht, selbst wenn sie in mehreren Blöcken vorhanden ist.