コンテンツへスキップ

アセットの処理

圧縮

Blockstudioは、ブロック内のすべてのCSSファイルとJSファイルを自動的に圧縮できます。

コンパイル済みファイルはブロックの_distフォルダーに保存され、ブロックの使用時に読み込まれます。ソースファイルが更新されると、Blockstudioはそのタイムスタンプに対応するコンパイル済みファイルがあるか確認し、なければ作成します。

この処理にはminifyライブラリを使用します。

assets/minify設定で圧縮を有効にできます:

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

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

SCSS

SCSSでスタイルを記述する場合は、SCSS処理を有効にできます:

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

これにより、.cssファイルのSCSS処理が有効になります。

または、.scss拡張機能を使用すると、上記の設定がtrueでもスタイルが自動的に処理されます。

インポートパス

SCSSを使うと、ほかのSCSSファイルをインポートできます。インポート先は、インポート元ファイルからの相対パスで指定します。

CSS
@import "modules.scss";

さらに、blockstudio/assets/process/scss/import_pathsフィルターでカスタムのインポートパスを定義できます。これにより、フォルダー構成を指定せずに別のディレクトリからファイルをインポートできます。

インポートでは.scss拡張子を省略でき、_tokens.scssのようなパーシャルやディレクトリの_index.scssも解決されます。

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

プリリュード

すべてのSCSSファイルで共通のSass関数、変数、ミックスイン、ユーティリティを使うには、コンパイル前にグローバルなプリリュードを追加できます。

これはBootstrapなどのフレームワークで便利です。各ブロックのアセットにインポートを繰り返し記述せずに、ブレークポイント用の共通ミックスインなどを利用できます。

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

blockstudio/assets/process/scss/import_pathsと組み合わせると、参照するSassの内容をすべてのコンパイル済みファイルで利用できます。

依存ファイルの更新日時が変わると、ほかのパーシャルからインポートされたファイルを含め、ブロックのアセットが再コンパイルされます。Blockstudioはローカルの@import、@use、@forwardの依存関係を追跡します。プリリュードの依存ファイルや設定済みのインポートパスも対象です。共有する依存ファイルは一度だけ追跡され、依存関係の検出中に循環して処理が止まらなくなることもありません。これらのファイルは実行時キャッシュの監視リストにも含まれます。

たとえば、mixins/_wysiwyg.scssを編集すると、scss/_wysiwyg.scssをインポートしているglobal-styles.scssが再コンパイルされ、そのファイルがさらにそのミックスインをインポートする場合も同様です。エントリーファイルを編集する必要はありません。Sassの組み込みモジュールとリモートインポートは、ローカル依存関係グラフの対象外です。

ESモジュール

Blockstudio内のすべてのスクリプト(インラインとデフォルト)には、標準でtype="module"が適用されます。そのため、追加設定なしでブロックのスクリプトにインポート構文を使用できます。

注

ESモジュールについて詳しくは、MDNのウェブドキュメントをご覧ください。

script.js内に次のコードがあるとします:

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

上記の例では、Preactを使ってコンポーネントを作成し、ESM対応のCDN(ここではesm.sh)から必要なコンポーネントや関数をすべてインポートしています。この方法にも問題はありませんが、必要なアセットを外部サイトから取得する必要があり、CDNがダウンするとスクリプトが動かなくなるリスクがあります。

Blockstudioには、ESモジュールをブロックにダウンロードする便利な機能があり、本番環境で外部のESM CDNを使わずに済みます。

設定

モジュールをブロックのディレクトリにダウンロードするには、npm:プレフィックスの後にパッケージ名とバージョンを指定します:

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

この構文は、Denoのnpm指定子の規則に沿っています。

注

旧形式のblockstudio/プレフィックス(e.g、blockstudio/preact@10.15.1)も後方互換性のため引き続き使えますが、新しいプロジェクトではnpm:プレフィックスをおすすめします。詳しくは移行ガイドをご覧ください。

Blockstudioは変更された.jsファイルのインポートを自動的に確認し、ブロックのローカルディレクトリにダウンロードします。ダウンロードしたファイルは、ブロックディレクトリ内のmodulesフォルダーに配置されます。

ローカルでホストするモジュールに合わせて、保存時にスクリプトファイルが書き換えられます:

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

エディター内でブロックをプレビューしたり編集したりする際は、引き続きCDN URLが使われます(Blockstudioはesm.shを使用します)。

注意点

バージョン

通常、CDNからモジュールを使う場合、バージョン番号を省略できます。その場合は常に最新バージョンが使われます。Blockstudioはデータベースに情報を保存しないため、モジュールを使う際にはバージョン番号が必要です。

同じモジュール

モジュールはブロックごとに管理されます。複数のブロックで同じバージョンの同じモジュールを使っていても、Blockstudioは指定されたモジュールを各ブロックにダウンロードします。ブロックは、ほかのインストール環境やサイトと簡単に共有できる自己完結した単位であるべきだからです。

さらに、両方のブロックがページにある場合、同じモジュールが2回読み込まれます。script.jsファイルの代わりにscript-inline.jsを使うと、この問題を解決できます。Blockstudioは名前とバージョン番号が一致する各インポートを書き換え、そのモジュールが最初に読み込まれた場所を参照するようにします。

CSSローダー

上記と同じ構文を使ってCSSファイルをインポートすることもできます。

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

CSSファイルはmodulesフォルダーにダウンロードされ、ブロックの使用時に自動的に読み込まれます。バージョンが同じであれば、複数のブロックに同じCSSファイルがあっても、読み込まれるのは1つだけです。