Pāriet uz saturu

Canvas

Canvas sniedz tālinātu, Figma līdzīgu pārskatu par visām Blockstudio pārvaldītajām lapām. Katra lapa tiek attēlota kā aktīvs iframe laukums vienā horizontālā rindā. Pārvietojiet skatu ar skārienpaliktni, tuviniet vai tāliniet ar savilkšanas žestu vai Ctrl+ritināšanu.

Aktivizēšana

Canvas ir pieejams kā slēpta administrēšanas lapa. Dodieties uz:

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

Lapai var piekļūt tikai tad, ja dev.canvas.enabled ir true un pašreizējam lietotājam ir edit_posts iespēja.

Iestatījumi

Iespējojiet Canvas un konfigurējiet tā darbību savas tēmas blockstudio.json:

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
Rekvizīts Tips Noklusējums Apraksts
enabled boolean false Iespējo Canvas funkciju.
adminBar boolean true Rāda WordPress administrēšanas joslu artboard iframe elementos. Iestatiet false, lai iegūtu tīrāku priekšskatījumu.

Abi iestatījumi ir pieejami arī kā filtri:

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

Skati

Pārslēdzieties starp skatiem, izmantojot nolaižamo izvēlni augšējā labajā stūrī.

  • Lapas: visas Blockstudio pārvaldītās lapas kā pilna platuma artboard elementi vienā rindā.
  • Bloki: visi reģistrētie Blockstudio bloki režģī, katrs attēlots ar noklusējuma atribūtu vērtībām.

Publiskais inventārs un dokumenta API

Canvas piedāvā versētu, no patērētāja neatkarīgu PHP līgumu rīkiem, kuriem vajadzīgs viens un tas pats reģistrētais saturs, nepārbūvējot Blockstudio atklāšanas vai renderēšanas loģiku:

PHP
use Blockstudio\Canvas;

$all = Canvas::inventory();

$changed = Canvas::inventory([
  'blocks' => ['theme/hero'],
  'pages' => ['about'],
]);

$documents = Canvas::documents([
  'patterns' => ['theme/featured'],
  'templates' => ['front-page'],
]);

Pašreizējā versija ir pieejama kā Canvas::SCHEMA_VERSION. Inventāra rezultātos ir:

  • inventory: normalizēti pages, blocks, patterns, templates, parts un publiskās ui saimes piemēri
  • order: stabila secība, kādā tiek attēloti dažādu tipu ieraksti
  • sources: precīzi atlasītie avota ceļi ar izcelsmes informāciju katram ierakstam; lapas ierakstā source ir stabila avota identitāte, savukārt path ir fiziskais renderēšanas veidnes ceļš
  • warnings un errors: strukturētas problēmas, nevis ģenerēta izvade
  • deleted: pieprasītie identifikatori, kas vairs nepastāv
  • selection: normalizētā atlase un norāde, vai tā ir mērķēta

Canvas::documents() katram atlasītajam ierakstam pievieno pilnu renderēšanas dokumentu. Katrā dokumentā ir tā pamatdaļa, apkopotais HTML, no atkarībām noslēgts bloku nosaukumu saraksts un precīzi CSS, JavaScript, moduļi, interaktivitātes inicializācijas kods, komplektētie UI globālie objekti un Tailwind izvade. Lapu dokumentos izmantots semantisks <main> satura ietvars; izsaucēji to var mainīt vai atspējot, izmantojot kopīgās renderēšanas dokumenta opcijas. Katra atlasītā lapa tiek renderēta savā atjaunotajā priekšgala WordPress kontekstā, tāpēc vaicājumu nosacījumi, body klases filtri, īskodi, izkārtojumi, novirzīšanas un wp_enqueue_scripts atzvani darbojas ar attiecīgo lapu, nevis ar administratora vai REST pieprasījumu, kas pieprasīja Canvas rezultātu. Izsaucēja norādītās body klases tiek apvienotas ar lapas konteksta klasēm, bet priekšgala pievienošanas reģistri katram dokumentam ir izolēti. Canvas šos dzīves cikla atzvanus atrod pēc to publiskajiem WordPress funkciju nosaukumiem, tāpēc tas pats konteksts tiek saglabāts, kad Blockstudio tiek ielādēts, izmantojot Composer vai pārvietotu lietotnes nosaukumvietu.

Precīza atlases semantika

Atlase ir stingra:

  • Ja nav atpazītu tipu atslēgu, tiek ielādēti visi tipi.
  • true, null vai "*" ielādē visus attiecīgā tipa ierakstus.
  • Virkne vai saraksts ielādē tikai precīzi norādītos ID, nosaukumus, slug vērtības, ceļus vai avota ceļus.
  • Tukša virkne, saraksts vai false neielādē nevienu attiecīgā tipa ierakstu.
  • Tiklīdz ir norādīta kāda tipa atslēga, nenorādītie tipi netiek atklāti, sinhronizēti, renderēti vai kompilēti.

Tāpēc pieprasījumi, kuros vajadzīgas tikai izmaiņas, ir droši arī lielos projektos. Esošie bloki un lapas tiek atrasti to kanoniskajos reģistros. Ja priekšgala pieprasījumā ir ielādēts tikai saglabātais lapas projekcijas dati, Canvas veic tikai lasāmu avota atklāšanu un apvieno atbilstošos ierakstu ID un pastāvīgās saites, nesinhronizējot saturu. Tāda pati identitāšu apvienošana notiek, ja loģisks atklāšanas avots vispirms aizpilda reģistru, ko nodrošina avots, tāpēc kontekstuālā lapas renderēšana joprojām izmanto atbilstošo pārvaldīto WordPress ierakstu. Jauna aktīvās sesijas topoloģija tiek atklāta tikai ap mainīto direktoriju, savukārt atlasītie rakstu un Site Editor veidņu avoti tiek kompilēti tikai pēc atlases.

REST atsvaidzināšanas galapunkts ievēro to pašu noteikumu attiecībā uz esošajiem blocks un pages vaicājuma parametriem. Piemēram, ?blocks=theme/hero atgriež šo bloku un nevienu lapu; jauktai atbildei izmantojiet abus parametrus. Izsaucot galapunktu bez neviena no parametriem, tiek saglabāta pilna mantotā atbilde.

Tiešraides režīms

Tiešraides režīmā tiek izmantoti Server-Sent Events (SSE), lai noteiktu failu izmaiņas un atjauninātu Canvas reāllaikā. Rediģējot bloka veidni, lapas veidni vai stilu lapu, attiecīgie artboard elementi automātiski tiek atsvaidzināti aptuveni vienas sekundes laikā.

Tiešraides režīmu var ieslēgt vai izslēgt nolaižamajā izvēlnē. Kad tas ir aktīvs, tiek rādīts pulsējošs zaļš indikators. Iestatījums tiek saglabāts starp sesijām, izmantojot localStorage.

Tiešraides režīms uzrauga izmaiņas .php, .json, .css, .scss, .js, .twig un .html failos bloku un lapu direktorijās. Ja tiek rediģēts zināms fails, tiek atsvaidzināts tikai tā reģistrētais bloks vai lapa. Ja tiek izveidots jauns bloks vai lapa, tiek veikta viena topoloģijas pārbaude attiecīgajā direktorijā, tāpēc jauna satura izveide atvērtas tiešraides sesijas laikā joprojām darbojas, nepārmeklējot nesaistītus avotus.

Fokusa režīms

Noklikšķiniet uz jebkura artboard nosaukuma, lai atvērtu fokusa režīmu. Atlasītais artboard aizpilda visu skata laukumu platumā un ir ritināms vertikāli. Nospiediet Escape vai noklikšķiniet uz aizvēršanas pogas, lai atgrieztos pārskatā.

Vadīklas

Darbība Ievade
Panoramēšana Ritināšana / divu pirkstu vilkšana skārienpaliktnī
Tālummaiņa Ctrl+ritināšana vai savilkšanas žests
Ietilpināt skatā Nolaižamā izvēlne
Tuvināt līdz 100% Nolaižamā izvēlne
Fokusēt artboard Noklikšķiniet uz artboard nosaukuma
Iziet no fokusa Escape / aizvēršanas poga

Drošība

Canvas skripts un lapas dati tiek ielādēti tikai tad, ja ir izpildīti visi nosacījumi:

  • Iestatījums dev.canvas.enabled ir true.
  • Pašreizējam lietotājam ir iespēja edit_posts.

Publiskie apmeklētāji nekad neredz canvas skriptu vai lapas metadatus.