Перейти до вмісту

Обробка ресурсів

Мінімізація

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

Це ввімкне обробку SCSS для файлів .css.

Також можна використовувати розширення .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;
});

Прелюдія

Щоб спільні функції Sass, змінні, міксини чи утиліти були доступні в кожному файлі SCSS, перед компіляцією можна додати глобальну прелюдію.

Це корисно для таких фреймворків, як 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 призводить до повторної компіляції global-styles.scss, якщо він імпортує scss/_wysiwyg.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, імпортуючи всі необхідні компоненти й функції з пакета CDN, сумісного з ESM, у цьому випадку — esm.sh. У цьому підході немає нічого поганого, але він має недолік: необхідні ресурси доводиться завантажувати із зовнішнього сайту, а якщо CDN не працюватиме, скрипти можуть зламатися.

Blockstudio має зручний спосіб завантажувати модулі ES у блок, усуваючи потребу в зовнішніх CDN ESM під час розгортання.

Налаштування

Щоб завантажити модуль до каталогу блока, додайте префікс 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";

У редакторі під час попереднього перегляду та роботи з блоком і далі використовуватиметься URL CDN (Blockstudio використовує esm.sh).

Застереження

Версія

Зазвичай модулі можна використовувати з CDN без номера версії. У такому разі завжди використовуватиметься найновіша версія. Оскільки Blockstudio не зберігає жодних даних у базі даних, під час використання модулів потрібно вказувати номер версії.

Однакові модулі

Модулі належать до своїх блоків. Навіть якщо використовувати той самий модуль із тим самим номером версії в кількох блоках, Blockstudio однаково завантажить запитаний модуль у каталог блока. Це потрібно насамперед тому, що блоки мають бути самодостатніми одиницями, якими легко ділитися між різними інсталяціями чи сайтами.

Крім того, той самий модуль буде запитано двічі, якщо на сторінці присутні обидва блоки. Цю проблему можна розв’язати, використовуючи script-inline.js замість файла script.js. Blockstudio перепише кожен імпорт так, щоб він указував на розташування першого екземпляра модуля, якщо назва й номер версії збігаються.

Завантажувач CSS

Також можна імпортувати файли CSS за допомогою того самого синтаксису, що й вище.

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

Файл CSS буде завантажено до папки modules і автоматично додано в чергу, коли блок використовується. Якщо версія однакова, у чергу буде додано лише одну версію файла CSS, навіть якщо він є в кількох блоках.