Siirry sisältöön

Canvas

Canvas tarjoaa loitonnetun, Figma-tyylisen yleiskuvan kaikista Blockstudio-hallituista sivuista. Kukin sivu näkyy vaakasuuntaisen rivin reaaliaikaisena iframe-työalueena. Panoroi ohjauslevyllä ja lähennä nipistämällä tai Ctrl+vierittämällä.

Aktivointi

Canvas on käytettävissä piilotettuna ylläpitosivuna. Siirry osoitteeseen:

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

Sivulle pääsee vain, kun dev.canvas.enabled on true ja nykyisellä käyttäjällä on käyttöoikeus edit_posts.

Asetukset

Ota Canvas käyttöön ja määritä sen toiminta teemasi kohteessa blockstudio.json:

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
Ominaisuus Tyyppi Oletus Kuvaus
enabled boolean false Ota Canvas-ominaisuus käyttöön.
adminBar boolean true Näytä WordPress-ylläpitopalkki työalueen iframe-kehyksissä. Aseta arvoksi false, jos haluat siistimmän esikatselun.

Molemmat asetukset ovat käytettävissä myös suodattimina:

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

Näkymät

Vaihda näkymää oikean yläkulman pudotusvalikosta.

  • Sivut: kaikki Blockstudio-hallinnoidut sivut täysleveinä työalueina yhdessä rivissä.
  • Lohkot: kaikki rekisteröidyt Blockstudio-lohkot ruudukossa; jokainen renderöidään oletusarvoisilla ominaisuusarvoillaan.

Julkinen inventaario ja dokumentin API

Canvas tarjoaa versioidun, kuluttajaneutraalin PHP-sopimuksen työkaluille, jotka tarvitsevat samat rekisteröidyt sisällöt rakentamatta uudelleen kohteen Blockstudio löytämis- tai renderöintilogiikkaa:

PHP
use Blockstudio\Canvas;

$all = Canvas::inventory();

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

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

Nykyinen versio on saatavilla muodossa Canvas::SCHEMA_VERSION. Inventaarion tulokset sisältävät:

  • inventory: normalisoidut pages, blocks, patterns, templates, parts ja julkiset esimerkit ui-perheestä
  • order: vakaa, tyyppien välinen näyttöjärjestys
  • sources: tarkat valitut lähdepolut sekä kunkin tietueen alkuperätiedot; sivutietueen source on sen vakaa lähdetunniste, kun taas path on fyysisen renderöintimallin polku
  • warnings ja errors: jäsennellyt ongelmat tuotetun tulosteen sijaan
  • deleted: pyydetyt tunnisteet, joita ei enää ole
  • selection: normalisoitu valinta ja tieto siitä, kohdistettiinko se tiettyyn kohteeseen

Canvas::documents() lisää jokaiselle valitulle tietueelle yhden täydellisen renderöintidokumentin. Kukin dokumentti sisältää runkonsa, koostetun HTML-sisältönsä, riippuvuuksiltaan suljetut lohkonimet sekä tarkat kohteet CSS, JavaScript, moduulit, interaktiivisuuden käynnistysosan, mukaan pakatut UI-globaalit ja Tailwind-tulosteen. Sivudokumenteissa käytetään semanttista <main>-sisältöelementtiä. Kutsuja voi ohittaa tai poistaa sen käytöstä jaetun Render-dokumentin asetuksissa. Kukin valittu sivu renderöidään omassa palautetussa käyttöliittymän WordPress-kontekstissaan, joten kyselyehdot, body-luokan suodattimet, lyhytkoodit, asettelut, uudelleenohjaukset ja wp_enqueue_scripts-takaisinkutsut tarkastelevat kyseistä sivua Canvas-tulosta pyytäneen ylläpidon tai REST-pyynnön sijaan. Kutsujan antamat body-luokat yhdistetään sivun kontekstuaalisiin luokkiin, ja käyttöliittymän enqueue-rekisterit eristetään dokumenttien välillä. Canvas ratkaisee nämä elinkaaren takaisinkutsut niiden julkisten WordPress-funktionimien avulla, joten sama konteksti säilyy myös silloin, kun Blockstudio ladataan kohteen Composer tai siirretyn sovellusnimiavaruuden kautta.

Tarkan valinnan semantiikka

Valinta on tiukka:

  • Jos tyypin tunnisteavaimia ei tunnisteta, ladataan kaikki tyypit.
  • Arvot true, null tai "*" lataavat kaikki kyseisen tyypin tietueet.
  • Merkkijono tai luettelo lataa vain täsmälliset tunnukset, nimet, polkutunnukset, polut tai lähdepolut.
  • Tyhjä merkkijono tai luettelo tai arvo false ei lataa kyseisen tyypin tietueita.
  • Kun jokin tyypin tunnisteavain on annettu, pois jätettyjä tyyppejä ei etsitä, synkronoida, renderöidä eikä käännetä.

Näin vain muuttuneet osat kattavat pyynnöt ovat turvallisia suurissa projekteissa. Olemassa olevat lohkot ja sivut ratkaistaan kanonisten rekisteriensä kautta. Jos käyttöliittymän pyynnössä on ladattu vain pysyvä sivuprojisointi, Canvas etsii lähteitä vain luku -tilassa ja yhdistää vastaavat julkaisujen tunnukset ja kestolinkit synkronoimatta sisältöä. Sama tunnisteiden yhdistäminen tehdään, kun looginen löytämislähde täyttää ensin lähdepohjaisen rekisterin, jotta sivun kontekstuaalisessa renderöinnissä käytetään vastaavaa hallittua WordPress-julkaisua. Uuden reaaliaikaisen istunnon rakennetta etsitään vain muuttuneen hakemiston ympäriltä, ja valitut pattern- sekä Site Editor -mallipohjien lähteet käännetään vasta valinnan jälkeen.

REST-päivityspäätepiste noudattaa samaa sääntöä olemassa olevien kyselyparametrien blocks ja pages osalta. Esimerkiksi ?blocks=theme/hero palauttaa kyseisen lohkon eikä yhtään sivua; sekoitettua vastausta varten käytä molempia parametreja. Jos päätepistettä kutsutaan ilman kumpaakaan parametria, täydellinen vanha vastaus säilyy.

Reaaliaikainen tila

Reaaliaikainen tila käyttää Server-Sent Events (SSE) -tapahtumia tiedostomuutosten havaitsemiseen ja Canvasin päivittämiseen reaaliajassa. Kun muokkaat lohkomallipohjaa, sivumallipohjaa tai tyylitiedostoa, muutokset näkyvät kyseisillä työalueilla automaattisesti noin sekunnissa.

Ota reaaliaikainen tila käyttöön tai poista se käytöstä pudotusvalikosta. Aktiivisena näkyy vihreä sykkivä merkkivalo. Asetus säilyy istuntojen välillä localStorage-tallennuksen avulla.

Reaaliaikainen tila seuraa tiedostomuutoksia hakemistojen lohko- ja sivukansioissa tiedostoissa .php, .json, .css, .scss, .js, .twig ja .html. Tunnetut muokkaukset päivittävät vain niihin rekisteröidyn lohkon tai sivun. Aidosti uusi lohko tai sivu käynnistää yhden hakemistokohtaisen rakennetarkistuksen, joten sisällön luominen avoimen reaaliaikaisen istunnon aikana toimii edelleen ilman muiden lähteiden uutta kartoitusta.

Tarkennustila

Napsauta mitä tahansa piirtoalueen nimeä siirtyäksesi kohdistustilaan. Valittu piirtoalue täyttää näkymän koko leveydeltä ja sitä voi vierittää pystysuunnassa. Palaa yleisnäkymään painamalla Escape-näppäintä tai napsauttamalla sulkupainiketta.

Ohjaimet

Toiminto Syöte
Panoroi Vieritys / kahden sormen vetäisy ohjauslevyllä
Zoomaa Ctrl+vieritys tai nipistys
Sovita näkymään Pudotusvalikko
Zoomaa tasolle 100% Pudotusvalikko
Kohdista piirtoalueeseen Napsauta piirtoalueen nimeä
Poistu kohdistuksesta Escape / sulkupainike

Tietoturva

Piirtoalueen komentosarja ja sivun tiedot ladataan vain, kun kaikki seuraavat ehdot täyttyvät:

  • dev.canvas.enabled-asetus on true.
  • Nykyisellä käyttäjällä on edit_posts-oikeus.

Julkiset kävijät eivät koskaan näe piirtoalueen komentosarjaa tai sivun metatietoja.