Холст
Холст показывает все страницы под управлением Blockstudio в уменьшенном масштабе, подобно Figma. Каждая страница отображается как действующая монтажная область в iframe; все они расположены в один горизонтальный ряд. Перемещайте холст трекпадом, меняйте масштаб жестом сведения или прокруткой с Ctrl.
Активация
Холст доступен на скрытой странице администрирования. Перейдите по адресу:
/wp-admin/admin.php?page=blockstudio-canvas
Страница доступна только если dev.canvas.enabled имеет значение true и у текущего пользователя есть возможность edit_posts.
Настройки
Включите холст и настройте его работу в blockstudio.json вашей темы:
{
"dev": {
"canvas": {
"enabled": true,
"adminBar": false
}
}
}
| Свойство | Тип | По умолчанию | Описание |
|---|---|---|---|
enabled |
boolean |
false |
Включает функцию холста. |
adminBar |
boolean |
true |
Показывает панель администратора WordPress внутри iframe монтажных областей. Установите значение false, чтобы получить более чистый предпросмотр. |
Обе настройки также доступны через фильтры:
add_filter('blockstudio/settings/dev/canvas/enabled', '__return_true');
add_filter('blockstudio/settings/dev/canvas/admin_bar', '__return_false');
Представления
Переключайтесь между представлениями с помощью раскрывающегося меню в правом верхнем углу.
- Страницы: все страницы под управлением Blockstudio представлены полноразмерными монтажными областями в один ряд.
- Блоки: все зарегистрированные блоки Blockstudio представлены сеткой; каждый блок отображается со значениями атрибутов по умолчанию.
Общедоступный перечень и документ API
Canvas предоставляет версионируемый, независимый от потребителя контракт PHP для инструментов, которым нужен тот же перечень зарегистрированного содержимого без повторной разработки логики обнаружения или рендеринга Blockstudio:
use Blockstudio\Canvas;
$all = Canvas::inventory();
$changed = Canvas::inventory([
'blocks' => ['theme/hero'],
'pages' => ['about'],
]);
$documents = Canvas::documents([
'patterns' => ['theme/featured'],
'templates' => ['front-page'],
]);
Текущая версия доступна как Canvas::SCHEMA_VERSION. Результаты перечня содержат:
inventory: нормализованныеpages,blocks,patterns,templates,partsи примеры общедоступных семействuiorder: стабильный общий порядок отображения типовsources: точные выбранные пути к исходникам с указанием происхождения каждой записи;sourceзаписи страницы — это стабильный идентификатор ее исходника, тогда какpath— путь к физическому шаблону рендерингаwarningsиerrors: структурированные проблемы вместо сгенерированного выводаdeleted: запрошенные идентификаторы, которые больше не существуютselection: нормализованный выбор и указание, был ли он целевым
Canvas::documents() добавляет по одному полному документу рендеринга для каждой выбранной записи.
Каждый документ содержит тело, собранный HTML, имена блоков со всеми необходимыми зависимостями,
а также точные CSS, JavaScript, модули, код инициализации интерактивности, подключенные глобальные объекты UI
и результат Tailwind. В документах страниц используется семантическая обертка содержимого <main>;
вызывающий код может переопределить или отключить ее через общие параметры документа Render.
Каждая выбранная страница рендерится в собственном восстановленном контексте внешнего интерфейса WordPress, поэтому
условия запроса, фильтры классов body, шорткоды, макеты, перенаправления и обработчики wp_enqueue_scripts относятся к этой странице, а не к запросу администратора или REST,
который запросил результат Canvas. Переданные вызывающим кодом классы body объединяются с контекстными классами страницы, а реестры подключений внешнего интерфейса изолируются для каждого документа. Canvas находит эти обработчики жизненного цикла по общедоступным именам функций WordPress, поэтому контекст сохраняется и при загрузке Blockstudio через Composer или в перемещенном пространстве имен приложения.
Точная семантика выбора
Выбор выполняется строго:
- Если не распознаны ключи типов, загружаются все типы.
- Значение
true,nullили"*"загружает все записи этого типа. - Строка или список загружает только записи с точными идентификаторами, названиями, слагами, путями или путями к исходникам.
- Пустая строка или список, а также
falseне загружают записи этого типа. - Если указан хотя бы один ключ типа, остальные типы не обнаруживаются, не синхронизируются, не рендерятся и не компилируются.
Это позволяет безопасно отправлять запросы только для измененных элементов в крупных проектах. Существующие блоки и страницы находятся через канонические реестры. Если при запросе внешнего интерфейса загружена только сохраненная проекция страницы, Canvas обнаруживает исходники только для чтения и объединяет совпадающие идентификаторы записей и постоянные ссылки, не синхронизируя содержимое. То же объединение идентификаторов применяется, когда логический источник обнаружения сначала заполняет реестр, связанный с исходниками, поэтому при контекстном рендеринге страницы используется соответствующая управляемая запись WordPress. Новая топология текущего сеанса обнаруживается только рядом с измененным каталогом, а выбранные источники шаблонов Pattern и Site Editor компилируются только после выбора.
Конечная точка обновления REST соблюдает то же правило для существующих параметров запроса blocks и pages. Например, ?blocks=theme/hero возвращает этот блок и ни одной страницы; для смешанного ответа используйте оба параметра. Вызов конечной точки без обоих параметров сохраняет полный устаревший формат ответа.
Режим реального времени
Режим реального времени использует Server-Sent Events (SSE), чтобы обнаруживать изменения файлов и обновлять холст. Когда вы редактируете шаблон блока, шаблон страницы или таблицу стилей, соответствующие монтажные области автоматически обновляются примерно за одну секунду.
Включайте и выключайте режим реального времени через раскрывающееся меню. При его работе отображается пульсирующий зеленый индикатор. Настройка сохраняется между сеансами в localStorage.
Режим реального времени отслеживает изменения файлов .php, .json, .css, .scss, .js, .twig и .html в каталогах блоков и страниц. Известные изменения обновляют только соответствующий зарегистрированный блок или страницу. При появлении действительно нового блока или страницы проверяется топология только соответствующего каталога, поэтому создание содержимого в открытом сеансе реального времени работает без повторного сканирования посторонних источников.
Режим фокусировки
Нажмите на подпись монтажной области, чтобы перейти в режим фокусировки. Выбранная область займет всю ширину окна, и ее можно будет прокручивать по вертикали. Нажмите Escape или кнопку закрытия, чтобы вернуться к обзору.
Управление
| Действие | Ввод |
|---|---|
| Перемещение | Прокрутка / перетаскивание двумя пальцами по трекпаду |
| Масштаб | Ctrl+прокрутка или сведение пальцев |
| Подгонка под область просмотра | Раскрывающееся меню |
| Масштаб до 100% | Раскрывающееся меню |
| Фокусировка на монтажной области | Нажатие на подпись области |
| Выход из режима фокусировки | Escape / кнопка закрытия |
Безопасность
Скрипт canvas и данные страницы загружаются, только когда выполнены все условия:
- Параметр
dev.canvas.enabledимеет значениеtrue. - У текущего пользователя есть право
edit_posts.
Публичные посетители никогда не видят скрипт canvas или метаданные страницы.