Към съдържанието

Платно

Платното предлага отдалечен общ преглед в стил Figma на всички страници, управлявани от Blockstudio. Всяка страница се изобразява като активна дъска във вграден прозорец в един хоризонтален ред. Панорамирайте с тракпада и мащабирайте с жеста за събиране на пръсти или Ctrl+превъртане.

Активиране

Платното е достъпно като скрита административна страница. Отворете:

Код
/wp-admin/admin.php?page=blockstudio-canvas

Страницата е достъпна само когато dev.canvas.enabled е true и текущият потребител има правомощието edit_posts.

Настройки

Активирайте платното и конфигурирайте поведението му в blockstudio.json на темата си:

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
Свойство Тип По подразбиране Описание
enabled boolean false Активира функцията за платно.
adminBar boolean true Показва лентата за администрация на WordPress във вградените прозорци на дъските. Задайте false за по-изчистен преглед.

И двете настройки са налични и като филтри:

PHP
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:

PHP
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 и примери от публичното семейство ui
  • order: стабилният ред на показване между типовете
  • sources: точните избрани изходни пътища с произход за всеки запис; при запис за страница source е нейната стабилна идентичност на източника, докато path е физическият път до шаблона за изобразяване
  • warnings и errors: структурирани проблеми вместо генериран изход
  • deleted: заявени идентификатори, които вече не съществуват
  • selection: нормализираният избор и дали е насочен

Canvas::documents() добавя по един пълен документ за изобразяване за всеки избран запис. Всеки документ съдържа основното си съдържание, сглобен HTML, имената на блоковете и техните зависимости, както и точните CSS, JavaScript, модули, зареждане за интерактивност, глобални променливи на пакета UI, и изход Tailwind. Документите за страници използват семантичен контейнер за съдържание <main>; извикващият може да го замени или изключи чрез споделените опции на документа за изобразяване. Всяка избрана страница се изобразява в собствения си възстановен контекст на интерфейса WordPress, така че условията за заявки, филтрите за класове на тялото, кратките кодове, оформленията, пренасочванията и обратните извиквания wp_enqueue_scripts виждат тази страница, а не административната или заявката REST, която е поискала резултата от Canvas. Класовете за тялото, предоставени от извикващия, се обединяват с контекстните класове на страницата, а регистрите за добавяне на ресурси във фронтенда са изолирани между документите. Canvas разрешава тези обратни извиквания от жизнения цикъл чрез публичните им имена на функции WordPress, така че същият контекст се запазва, когато Blockstudio се зарежда чрез Composer или преместено пространство от имена на приложението.

Точна семантика на избора

Изборът е строг:

  • Ако няма разпознати ключове за типове, се зареждат всички типове.
  • true, null или "*" зарежда всички записи от съответния тип.
  • Низ или списък зарежда само точни ID, имена, кратки имена, пътища или изходни пътища.
  • Празен низ/списък или false не зарежда нищо от този тип.
  • След като е зададен ключ за някой тип, пропуснатите типове не се откриват, синхронизират, изобразяват или компилират.

Това прави заявките само за промененото безопасни за големи проекти. Съществуващите блокове и страници се намират чрез каноничните си регистри. Когато заявка към интерфейса има заредена само запазената проекция на страницата, Canvas извършва откриване на източника само за четене и обединява съвпадащите ID на публикации и постоянни връзки, без да синхронизира съдържание. Същото обединяване на идентичности се прилага, когато логически източник за откриване първо попълва регистъра, обвързан с източника, така че контекстното изобразяване на страница продължава да използва съответстващата управлявана публикация WordPress. Новата топология на текущата сесия се открива само около променената директория, а избраните шаблонни източници на образци и редактора на сайта се компилират едва след избора.

Крайната точка за обновяване REST следва същото правило за съществуващите параметри на заявката blocks и pages. Например, ?blocks=theme/hero връща този блок и нито една страница; използвайте и двата параметъра за смесен отговор. Извикването на крайната точка без нито един от параметрите запазва пълния стар отговор.

Режим в реално време

Режимът в реално време използва Server-Sent Events (SSE), за да открива промени във файловете и да обновява платното в реално време. Когато редактирате шаблон на блок, шаблон на страница или стилова таблица, засегнатите дъски се обновяват автоматично в рамките на около една секунда.

Включвайте и изключвайте режима в реално време от падащото меню. Когато е активен, се показва пулсиращ зелен индикатор. Настройката се запазва между сесиите чрез localStorage.

Режимът в реално време следи промените във файловете .php, .json, .css, .scss, .js, .twig и .html в директориите за блокове и страници. Познатите промени обновяват само съответния регистриран блок или страница. Наистина нов блок или страница задейства еднократно преминаване по топологията в рамките на директорията, така че създаването на съдържание в отворена сесия в реално време продължава да работи без повторно сканиране на несвързани източници.

Режим на фокус

Щракнете върху етикет на произволно работно поле, за да влезете в режим на фокус. Избраното работно поле заема цялата ширина на изгледа и можете да превъртате вертикално. Натиснете Escape или щракнете върху бутона за затваряне, за да се върнете към общия изглед.

Контроли

Действие Въвеждане
Панорамиране Превъртане / плъзгане с два пръста по тракпада
Мащабиране Ctrl+превъртане или щипване
Побиране в изгледа Падащо меню
Мащабиране до 100% Падащо меню
Фокус върху работно поле Щракване върху етикета на работното поле
Изход от фокуса Escape / бутон за затваряне

Сигурност

Скриптът на платното и данните на страницата се зареждат само когато са изпълнени всички условия:

  • Настройката dev.canvas.enabled е true.
  • Текущият потребител има правото edit_posts.

Посетителите никога не виждат скрипта на платното или метаданните на страницата.