Przejdź do treści

Canvas

Canvas zapewnia pomniejszony, przypominający Figma przegląd wszystkich stron zarządzanych przez Blockstudio. Każda strona jest wyświetlana jako aktywny obszar roboczy w elemencie iframe w jednym poziomym rzędzie. Przesuwaj widok gładzikiem, powiększaj gestem uszczypnięcia lub klawiszami Ctrl+scroll.

Aktywacja

Canvas jest dostępny jako ukryta strona administracyjna. Przejdź do:

Kod
/wp-admin/admin.php?page=blockstudio-canvas

Strona jest dostępna tylko wtedy, gdy dev.canvas.enabled ma wartość true, a bieżący użytkownik ma uprawnienie edit_posts.

Ustawienia

Włącz Canvas i skonfiguruj jego działanie w pliku blockstudio.json motywu:

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
Właściwość Typ Domyślnie Opis
enabled boolean false Włącza funkcję Canvas.
adminBar boolean true Wyświetla pasek administracyjny WordPress wewnątrz elementów iframe obszarów roboczych. Ustaw wartość false, aby uzyskać czystszy podgląd.

Oba ustawienia są również dostępne jako filtry:

PHP
add_filter('blockstudio/settings/dev/canvas/enabled', '__return_true');
add_filter('blockstudio/settings/dev/canvas/admin_bar', '__return_false');

Widoki

Przełączaj widoki za pomocą menu rozwijanego w prawym górnym rogu.

  • Strony: wszystkie strony zarządzane przez Blockstudio jako pełnowymiarowe obszary robocze w jednym rzędzie.
  • Bloki: wszystkie zarejestrowane bloki Blockstudio w układzie siatki, każdy renderowany z domyślnymi wartościami atrybutów.

Publiczny wykaz i dokument API

Canvas udostępnia wersjonowany kontrakt PHP, niezależny od konsumenta, dla narzędzi, które potrzebują tych samych zarejestrowanych treści bez ponownego tworzenia logiki wykrywania ani renderowania w 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'],
]);

Aktualna wersja jest dostępna jako Canvas::SCHEMA_VERSION. Wyniki wykazu zawierają:

  • inventory: znormalizowane przykłady rodzin pages, blocks, patterns, templates, parts i publicznej ui
  • order: stabilną kolejność wyświetlania między typami
  • sources: dokładnie wybrane ścieżki źródłowe wraz z informacją o pochodzeniu każdego rekordu; source rekordu strony to jego stabilna tożsamość źródłowa, a path to fizyczna ścieżka szablonu renderowania
  • warnings i errors: uporządkowane informacje o problemach zamiast wygenerowanego wyjścia
  • deleted: żądane identyfikatory, które już nie istnieją
  • selection: znormalizowany wybór oraz informacja, czy był ukierunkowany

Canvas::documents() dodaje po jednym kompletnym dokumencie renderowania dla każdego wybranego rekordu. Każdy dokument zawiera treść, złożony HTML, nazwy bloków wraz z zamkniętymi zależnościami oraz dokładne CSS, JavaScript, moduły, kod startowy interaktywności, dołączone globalne UI i wyjście Tailwind. Dokumenty stron używają semantycznego kontenera treści <main>; wywołujący mogą go zastąpić lub wyłączyć za pomocą wspólnych opcji dokumentu Render. Każda wybrana strona jest renderowana we własnym, odtworzonym kontekście WordPress frontendu, dlatego warunki zapytań, filtry klas body, shortcody, układy, przekierowania i wywołania zwrotne wp_enqueue_scripts dotyczą tej strony, a nie panelu administracyjnego ani żądania REST, które zażądało wyniku Canvas. Klasy body przekazane przez wywołującego są łączone z klasami kontekstowymi strony, a rejestry elementów dołączanych przez frontend są izolowane między dokumentami. Canvas rozpoznaje te wywołania zwrotne cyklu życia po ich publicznych nazwach funkcji WordPress, dzięki czemu ten sam kontekst zostaje zachowany, gdy Blockstudio jest ładowany przez Composer lub przeniesioną przestrzeń nazw aplikacji.

Zasady dokładnego wyboru

Wybór jest ścisły:

  • Brak rozpoznanych kluczy typów powoduje załadowanie wszystkich typów.
  • true, null lub "*" powoduje załadowanie wszystkich rekordów danego typu.
  • Ciąg znaków lub lista powoduje załadowanie wyłącznie dokładnie dopasowanych identyfikatorów, nazw, slugów, ścieżek lub ścieżek źródłowych.
  • Pusty ciąg/lista lub false powoduje, że nie zostanie załadowany żaden element danego typu.
  • Gdy obecny jest dowolny klucz typu, pominięte typy nie są wykrywane, synchronizowane, renderowane ani kompilowane.

Dzięki temu żądania obejmujące tylko zmienione elementy są bezpieczne w dużych projektach. Istniejące bloki i strony są rozpoznawane przez kanoniczne rejestry. Gdy żądanie frontendu załadowało tylko utrwalony widok projekcji strony, Canvas wykrywa źródło w trybie tylko do odczytu i scala pasujące identyfikatory postów oraz bezpośrednie odnośniki bez synchronizowania treści. To samo scalanie tożsamości ma zastosowanie, gdy logiczne źródło wykrywania najpierw wypełnia rejestr oparty na źródłach, dzięki czemu renderowanie strony w kontekście nadal korzysta z pasującego posta WordPress zarządzanego przez. Nowa topologia aktywnej sesji jest wykrywana tylko w pobliżu zmienionego katalogu, a wybrane źródła wzorców i szablonów edytora witryny są kompilowane dopiero po dokonaniu wyboru.

Punkt końcowy odświeżania REST stosuje tę samą zasadę do istniejących parametrów zapytania blocks i pages. Na przykład ?blocks=theme/hero zwraca ten blok i żadnych stron; użyj obu parametrów, aby uzyskać mieszany wynik. Wywołanie punktu końcowego bez żadnego z tych parametrów zachowuje pełną odpowiedź w starszym formacie.

Tryb na żywo

Tryb na żywo wykorzystuje Server-Sent Events (SSE) do wykrywania zmian plików i aktualizowania Canvas w czasie rzeczywistym. Po edycji szablonu bloku, szablonu strony lub arkusza stylów powiązane obszary robocze odświeżają się automatycznie w ciągu około sekundy.

Włączaj i wyłączaj tryb na żywo z menu rozwijanego. Gdy tryb jest aktywny, pojawia się pulsujący zielony wskaźnik. Ustawienie jest zachowywane między sesjami za pomocą localStorage.

Tryb na żywo śledzi zmiany plików .php, .json, .css, .scss, .js, .twig i .html w katalogach bloków i stron. Znane edycje odświeżają tylko zarejestrowany blok lub stronę. Naprawdę nowy blok lub strona powoduje jednorazowe wykrywanie topologii w obrębie katalogu, dzięki czemu tworzenie treści w trakcie otwartej sesji na żywo działa bez ponownego skanowania niezwiązanych źródeł.

Tryb skupienia

Kliknij etykietę dowolnego obszaru roboczego, aby przejść do trybu skupienia. Wybrany obszar wypełnia cały widok i można go przewijać w pionie. Naciśnij Escape lub kliknij przycisk zamykania, aby wrócić do przeglądu.

Sterowanie

Działanie Sterowanie
Przesuwanie widoku Przewijanie / przeciągnięcie dwoma palcami po gładziku
Powiększanie Ctrl+scroll lub gest uszczypnięcia
Dopasowanie do widoku Menu rozwijane
Powiększenie do 100% Menu rozwijane
Skupienie na obszarze roboczym Kliknięcie jego etykiety
Wyjście z trybu skupienia Escape / przycisk zamykania

Bezpieczeństwo

Skrypt canvas i dane strony są ładowane tylko po spełnieniu wszystkich warunków:

  • Ustawienie dev.canvas.enabled ma wartość true.
  • Bieżący użytkownik ma uprawnienie edit_posts.

Odwiedzający publiczną stronę nigdy nie widzą skryptu canvas ani metadanych strony.