Preskočiť na obsah

Plátno

Plátno poskytuje prehľad všetkých stránok spravovaných Blockstudio v zobrazení pripomínajúcom Figma z väčšej vzdialenosti. Každá stránka sa vykresľuje ako živá plocha iframe v jednom vodorovnom riadku. Posúvajte sa trackpadom, približujte alebo odďaľujte gestom priblíženia alebo klávesom Ctrl a rolovaním.

Aktivácia

Plátno je dostupné ako skrytá stránka administrácie. Prejdite na:

Kód
/wp-admin/admin.php?page=blockstudio-canvas

Stránka je dostupná iba vtedy, keď je dev.canvas.enabled true a aktuálny používateľ má oprávnenie edit_posts.

Nastavenia

Povoľte plátno a nakonfigurujte jeho správanie v blockstudio.json svojej témy:

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
Vlastnosť Typ Predvolená hodnota Opis
enabled boolean false Povoliť funkciu plátna.
adminBar boolean true Zobraziť administračný panel WordPress v rámci iframe plôch. Nastavte na false, aby bol náhľad čistejší.

Obe nastavenia sú dostupné aj ako filtre:

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

Zobrazenia

Medzi zobrazeniami prepínajte pomocou rozbaľovacej ponuky v pravom hornom rohu.

  • Stránky: Všetky stránky spravované Blockstudio ako plochy v plnej šírke v jednom riadku.
  • Bloky: Všetky registrované bloky Blockstudio v mriežke, každý vykreslený s predvolenými hodnotami atribútov.

Verejný inventár a dokument API

Canvas poskytuje verzovaný kontrakt PHP nezávislý od konzumenta pre nástroje, ktoré potrebujú rovnaký registrovaný obsah bez opätovného vytvárania logiky zisťovania alebo vykresľovania v 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'],
]);

Aktuálna verzia je dostupná ako Canvas::SCHEMA_VERSION. Výsledky inventára obsahujú:

  • inventory: normalizované pages, blocks, patterns, templates, parts a príklady verejnej rodiny ui
  • order: stabilné poradie zobrazenia naprieč typmi
  • sources: presné vybrané zdrojové cesty s pôvodom každého záznamu; pri zázname stránky je source jej stabilnou identitou zdroja, zatiaľ čo path je fyzická cesta k šablóne vykresľovania
  • warnings a errors: štruktúrované problémy namiesto vygenerovaného výstupu
  • deleted: požadované identifikátory, ktoré už neexistujú
  • selection: normalizovaný výber a informácia, či bol cielený

Canvas::documents() pridá jeden úplný dokument vykreslenia pre každý vybraný záznam. Každý dokument obsahuje telo, zostavené HTML, názvy blokov so všetkými uzavretými závislosťami a presné CSS, JavaScript, moduly, zavádzací kód interaktivity, globálne premenné UI zahrnuté v balíku a výstup Tailwind. Dokumenty stránok používajú sémantický obal obsahu <main>; volajúci ho môžu prepísať alebo vypnúť prostredníctvom spoločných možností dokumentu Render. Každá vybraná stránka sa vykresľuje vo vlastnom obnovenom kontexte frontend WordPress, takže podmienky dotazov, filtre tried tela, shortcodes, rozloženia, presmerovania a spätné volania wp_enqueue_scripts pracujú s danou stránkou, nie s požiadavkou administrácie alebo REST, ktorá si vyžiadala výsledok Canvas. Triedy tela zadané volajúcim sa zlúčia s kontextovými triedami stránky a registre frontend enqueue sú medzi dokumentmi oddelené. Canvas vyhľadáva tieto spätné volania životného cyklu podľa ich verejných názvov funkcií WordPress, takže sa zachová rovnaký kontext aj vtedy, keď sa Blockstudio načíta cez Composer alebo presunutý menný priestor aplikácie.

Presná sémantika výberu

Výber je striktný:

  • Bez rozpoznaných kľúčov typov sa načítajú všetky typy.
  • true, null alebo "*" načíta všetky záznamy daného typu.
  • Reťazec alebo zoznam načíta iba presné ID, názvy, slugy, cesty alebo zdrojové cesty.
  • Prázdny reťazec/zoznam alebo false nenačíta žiadne záznamy daného typu.
  • Ak je prítomný aspoň jeden kľúč typu, vynechané typy sa nezisťujú, nesynchronizujú, nevykresľujú ani nekompilujú.

Vďaka tomu sú požiadavky iba na zmenené položky bezpečné aj pri veľkých projektoch. Existujúce bloky a stránky sa vyhľadajú v kanonických registroch. Keď sa načíta iba uložený priemet stránky pre požiadavku frontendu, Canvas vykoná zisťovanie zdrojov iba na čítanie a zlúči zodpovedajúce ID príspevkov a trvalé odkazy bez synchronizácie obsahu. Rovnaké zlúčenie identít sa použije, keď logický zdroj zisťovania najprv naplní register založený na zdrojoch, takže kontextové vykresľovanie stránky stále používa zodpovedajúci spravovaný príspevok WordPress. Nová topológia živej relácie sa zisťuje iba v okolí zmeneného adresára, zatiaľ čo vybrané zdroje vzorov a šablón editora webu sa kompilujú až po výbere.

Obnovovací koncový bod REST sa riadi rovnakým pravidlom pre existujúce parametre dopytu blocks a pages. Napríklad ?blocks=theme/hero vráti daný blok a žiadne stránky; pre zmiešanú odpoveď použite oba parametre. Volanie koncového bodu bez ktoréhokoľvek z týchto parametrov zachováva úplnú staršiu odpoveď.

Živý režim

Živý režim používa Server-Sent Events (SSE) na zisťovanie zmien súborov a aktualizáciu plátna v reálnom čase. Keď upravíte šablónu bloku, šablónu stránky alebo šablónu so štýlmi, dotknuté plochy sa automaticky obnovia približne do jednej sekundy.

Živý režim zapnete alebo vypnete v rozbaľovacej ponuke. Po aktivácii sa zobrazí zelený pulzujúci indikátor. Nastavenie sa uchováva medzi reláciami pomocou localStorage.

Živý režim sleduje zmeny súborov .php, .json, .css, .scss, .js, .twig a .html v adresároch blokov a stránok. Známe úpravy obnovia iba svoj registrovaný blok alebo stránku. Úplne nový blok alebo stránka spustí jedno zisťovanie topológie v rámci adresára, takže vytváranie obsahu funguje aj počas otvorenej živej relácie bez opätovného prehľadávania nesúvisiacich zdrojov.

Režim zaostrenia

Kliknutím na ľubovoľný štítok artboardu aktivujete režim zamerania. Vybraný artboard vyplní zobrazovaciu plochu na celú šírku a môžete sa v ňom posúvať zvisle. Stlačením klávesu Escape alebo kliknutím na tlačidlo zavretia sa vrátite na prehľad.

Ovládanie

Akcia Vstup
Posúvanie Rolovanie / potiahnutie dvoma prstami na trackpade
Priblíženie Ctrl+rolovanie alebo gesto priblíženia
Prispôsobiť zobrazeniu Rozbaľovacia ponuka
Priblížiť na 100% Rozbaľovacia ponuka
Zamerať artboard Kliknutie na štítok artboardu
Ukončiť zameranie Escape / tlačidlo zavretia

Zabezpečenie

Skript plátna a údaje stránky sa načítajú iba pri splnení všetkých podmienok:

  • Nastavenie dev.canvas.enabled je true.
  • Aktuálny používateľ má oprávnenie edit_posts.

Verejní návštevníci nikdy neuvidia skript plátna ani metadáta stránky.