Na obsah stránky

Jednoduše a rychle: lit-html

Aleš Roubíček | | # permalink

Přiznejme si to. Dnešní stav tvorby webových frontendů není jednoduchý a začít novou věc vyžaduje spoustu kroků, které dříve nebyly potřeba a považovalo se to za výhodu webu. Dneska musíte znát Reacty, Babely, TypeScripty, Webpacky, CRAppy a co já vím, abyste vůbec vytvořili Hello World. Nebo aspoň si to velká část Frontend vývojářů asi myslí, že je to dobrý nápad, a tak webu lámou nožičky.

Nejen, že je takový přístup drahý na vývoj i údržbu, ale hlavně je to nesmysl. Já vím, velké enterprise systémy mají jiné požadavky… Je pak fajn, když za námi chodí zákazníci s přesně takovými systémy, že by potřebovali něco malého, rychlého a snadno použitelného, protože u nich to nejde.

No, ale dneska se pojďme raději věnovat něčemu jinému – knihovně Lit 2.0, která vám umožní psát jako v Reactu, ale bez všech těch zbytečných kejklí okolo. Tato knihovna vznikla v Google. V teamu, který tvořil framework Polymer. Knihovna využívá vlastnosti moderní webové platformy. Neřeší tak dávno neexistující problémy jako například nástroje, které jsem už jmenoval. Díky tomu může být malá (~5 KiB gzip), rychlá a dá se snadno komponovat s dalšími knihovnami, abyste mohli tvořit systémy, které řeší vaše business problémy. Nikoliv problémy špatných komplikovaných frameworků a nástrojů.

Knihovna Lit se historicky skládá ze dvou částí – lit-html a LitElement. Dnes se budeme věnovat té první.

lit-html

Knihovna lit-html má na starosti renderování šablon. Představte si React, který má jen čisté funkce jako komponenty, a místo JSX, který vyžaduje kompilační krok, používá nativní feature ECMAScriptu 2015 – tagované šablony.

Jako ukázku užití si vezmeme dynamické vkládání nekritických stylů do stránky:

<script type="module">
    import {render, html} from "https://unpkg.com/lit-html@2.0.0-rc.2/html.js?module";

    render(html`<link rel="stylesheet" href="/assets/main.css">`, document.head);
</script>

První věc, které si můžete všimnout, je použití ESM (ECMAScript Modules) v HTML. Jakmile máte podporu ESM modulů v browseru (je tam už asi 3 roky), máte většinu moderních vlastností ECMAScriptu k dispozici a nemusíte řešit transpilaci nebo polyfilly. A tak můžeme směle importovat!

Využijeme službu unpkg.com, která slouží jako CDN pro distribuci npm balíčků s možností transformace node_modules resolution na unpkg URLs – k tomu slouží GET parametr module. (Ano, Lit 2.0 je aktuálně v RC fázi, tj. těsně před releasem. Na Hlídači shopů ho i tak používáme v produkci už několik měsíců a to bez problémů.)

Z balíčku si vyzobneme funkci render a funkci html, která slouží k tagování textových literálů. Funkce render bere jako první parametr šablonu, jako druhý parametr, kam se má vyrenderovat, a třetí, nepovinný, parametr umožňuje přesněji specifikovat, jak se má vyrenderovaný kód vkládat.

Základní chování je takové, že se první render šablony připojí do cílového elementu nakonec. Další volání render už tento kus přepisuje. Tohle je jediná breaking change oproti lit-html 1.0, které vždy obsah elementu přepisovalo.

Tahat skoro 3 KiB závislostí jenom kvůli hezkému vložení stylopisu je samozřejmě nesmysl, ale je to pěkná ukázka mnoha zajímavých vlastností. Sami si to můžete hned vyzkoušet ve svém browseru, stačí vám jen DevTools, které tam už jsou. Zápis šablon je úplně přirozený. Nemusíte se učit žádnou novou speciální syntaxi, kterou byste museli kompilovat, stačí vám HTML a ECMAScript. Tak, jak v browserech jsou už roky.

Všimnout si můžete také toho, že funkci render nemusíte předávat žádnou komponentu, ale prostě kus šablony. Přidávat abstrakce můžete, až když je to potřeba. Jestli vůbec taková situace nastane. Stejně tak můžete začít s inline scripty ve stránkách a extrahovat je do samostatných souborů, až když potřebujete sdílet netriviální množství kódu mezi různými stránkami. Já třeba takto dělal web a PWA Hlídače shopů.

Šablonování

Tagované šablony umí interpolaci výrazů a proměnných, což nám umožňuje vytvářet opravdové šablony, do kterých se vkládají data.

export function resultsEmbed(url) {
  const parameters = new URLSearchParams({ url, view: "embed" });
  return html`
    <iframe
      sandbox="allow-same-origin allow-scripts allow-top-navigation allow-popups"
      class="hs-result__embed"
      src="/app/?${parameters}"
    ></iframe>
  `;
}

Tady třeba generujeme iframe s výsledky Hlídače. Pro naformátování GET parametrů použijeme užitečnou třídu URLSearchParams, která se postará o správné encodování hodnot parametrů. Ano, není to tak chytré jako Latte, které pozná samo, jak má vstupy encodovat, ale pořád máme po ruce všechna potřebná primitiva jazyka/platformy. Bez komplikací, bez magie.

Zajímavostí je, že v předchozí verzi 1.0 se u parameters muselo explicitně zavolat toString()/valueOf(). Ve verzi 2.0 se to chová, jak byste u interpolace proměnných v šabloně čekali.

Direktivy

Lit používá pro obohacení chování šablon speciální funkce – direktivy. Například, pokud používáte data, která implementují rozhraní Iterable, nemusíte nad nimi volat Array.from, abyste mohli použít metodu map pro mapování jednotlivých prvků. Můžete místo toho použít direktivu repeat:

export function shopsListTemplate(shops) {
  return html`
    <ul class="hs-shops-list">
      ${repeat(
        shops,
        ({ name, url }) => html`
          <li class="hs-shops-list__item">
            <a href="${url}">${name}</a>
          </li>
        `
      )}
    </ul>
  `;
}

V knihovně je zhruba tucet užitečných direktiv a zároveň základní třída pro implementaci vlastních direktiv.

Závěrem

Lit-html 2.0 je jednoduchá a malá knihovna, která nám umožňuje šablonovat HTML pomocí čistého ECMAScriptu bez potřeby jakýchkoliv kompilátorů. Zkrátka, otevřete browser, DevTools napojíte na lokální HTML soubor a můžete vyvíjet živou aplikaci (REPL style). Já ji používám jako náhradu jak jQuery, tak Reactu. Problémy, které ve své době řešili, jsou už pryč a není třeba s nimi uživatele mučit.

Pokud chcete z vašich šablon udělat znovu použitelné komponenty, můžete použít další část knihovny Lit – LitElement, na který se podíváme někdy příště. Prozradím jen, že jde o základní třídu pro psaní Web Components, která využívá lit-html pro šablonování a zjednodušuje API, které je podobné základní třídě React.Component. Jen je to malé (zhruba jako Preact), jednoduché a rychlé.

Našli jste v článku chybu? Máte námět na reportáž? Založte mi ticket.