Vyvolávání vlastních událostí

V JavaScriptu můžeme nejen přiřazovat handlery, ale také generovat události.

Vlastní události můžeme používat k vytváření „grafických komponent“. Například koÅ™enový element naÅ¡eho vlastního menu založeného na JS může spouÅ¡tÄ›t události, které budou říkat, co se dÄ›je s menu: otevři (otevÅ™ení menu), vyber (položka je vybrána) a podobnÄ›. Další kód může tÄ›mto událostem naslouchat a pozorovat, co se s menu dÄ›je.

Můžeme generovat nejenom úplnÄ› nové události, které si vymyslíme pro vlastní účely, ale také vestavÄ›né události, napÅ™. click, mousedown atd. To může být užitečné pro automatické testování.

Konstruktor události

Třídy vestavěných událostí tvoří hierarchii, podobně jako třídy DOM elementů. Jejím kořenem je vestavěná třída Event (událost).

Objekty třídy Event můžeme vytvářet následovnÄ›:

let událost = new Event(typ[, možnosti]);

Argumenty:

• typ – typ události, Å™etÄ›zec, napÅ™. "click" nebo náš vlastní, tÅ™eba "moje-událost".

• možnosti – objekt se dvÄ›ma nepovinnými vlastnostmi:

  • bubbles: true/false – pokud je true, pak událost bublá.
  • cancelable: true/false – pokud je true, pak lze zakázat „standardní akci“. PozdÄ›ji uvidíme, co to znamená pro vlastní události.

  StandardnÄ› jsou obÄ› vlastnosti false: {bubbles: false, cancelable: false}.

dispatchEvent

Když vytvoříme objekt události, mÄ›li bychom ji „spustit“ na nÄ›jakém elementu voláním elem.dispatchEvent(událost).

Pak na ni handlery budou reagovat, jako by to byla běžná událost prohlížeče. Pokud byla událost vytvoÅ™ena s příznakem bubbles, bude bublat.

V následujícím příkladu je v JavaScriptu spuÅ¡tÄ›na událost click. Handler funguje stejnÄ›, jako pÅ™i kliknutí na tlačítko:

<button id="elem" onclick="alert('Klik!');">Automatický klik</button>

<script>
  let událost = new Event("click");
  elem.dispatchEvent(událost);
</script>

Příklad bublání

Můžeme vytvoÅ™it bublající událost s názvem "ahoj" a zachytávat ji v document.

Stačí nastavit bubbles na true:

<h1 id="elem">Ahoj ze skriptu!</h1>

<script>
  // zachytávání v dokumentu...
  document.addEventListener("ahoj", function(událost) { // (1)
    alert("Ahoj z " + událost.target.tagName); // Ahoj z H1
  });

  // ...vyvoláme ji na elem!
  let událost = new Event("ahoj", {bubbles: true}); // (2)
  elem.dispatchEvent(událost);

  // handler na dokumentu se aktivuje a zobrazí zprávu.

</script>

Poznámky:

1. NaÅ¡e vlastní události bychom mÄ›li pÅ™idávat pomocí addEventListener, jelikož on<událost> existuje jedinÄ› pro vestavÄ›né události, document.onahoj nebude fungovat.
2. Musíme nastavit bubbles:true, jinak událost nebude bublat.

Mechanika bublání funguje pro vestavÄ›né (click) a vlastní (ahoj) události stejnÄ›. I u nich probíhá fáze zachytávání a fáze bublání.

MouseEvent, KeyboardEvent a jiné

Následuje krátký seznam událostí uživatelského rozhraní (UI) ze specifikace UI událostí:

• UIEvent
• FocusEvent
• MouseEvent
• WheelEvent
• KeyboardEvent
• …

Pokud chceme vytvoÅ™it takovou událost, mÄ›li bychom místo new Event používat je, například new MouseEvent("click").

Správný konstruktor nám umožňuje specifikovat standardní vlastnosti pro příslušný typ události.

Například clientX/clientY pro událost myÅ¡i:

let událost = new MouseEvent("click", {
  bubbles: true,
  cancelable: true,
  clientX: 100,
  clientY: 100
});

alert(událost.clientX); // 100

Prosíme vÅ¡imnÄ›te si, že generický konstruktor Event to neumožňuje.

Zkusme to:

let událost = new Event("click", {
  bubbles: true,    // v konstruktoru Event fungují
  cancelable: true, // pouze bubbles a cancelable
  clientX: 100,
  clientY: 100
});

alert(událost.clientX); // undefined, neznámá vlastnost je ignorována!

Technicky bychom to mohli obejít tak, že po vytvoÅ™ení události přímo pÅ™iÅ™adíme událost.clientX=100. Je to tedy otázka konvencí a dodržování pravidel. Události generované prohlížečem mají vždy správný typ.

Úplný seznam vlastností různých UI událostí je uveden ve specifikaci, například MouseEvent.

Vlastní události

Pro naÅ¡e vlastní, zcela nové typy událostí, napÅ™. "ahoj", bychom mÄ›li používat new CustomEvent. Technicky je CustomEvent totéž jako Event, ale s jednou výjimkou.

Ve druhém argumentu (v objektu) můžeme pÅ™idat další vlastnost detail s jakoukoli vlastní informací, kterou chceme události pÅ™edat.

Příklad:

<h1 id="elem">Ahoj pro Jana!</h1>

<script>
  // s událostí přijdou do handleru další detaily
  elem.addEventListener("ahoj", function(událost) {
    alert(událost.detail.jméno);
  });

  elem.dispatchEvent(new CustomEvent("ahoj", {
    detail: { jméno: "Jan" }
  }));
</script>

Vlastnost detail může obsahovat jakákoli data. Technicky se můžeme obejít i bez ní, protože běžnému objektu new Event můžeme po vytvoÅ™ení pÅ™iÅ™azovat jakékoli vlastnosti, ale CustomEvent k tomu poskytuje speciální pole detail, abychom se vyhnuli konfliktům s jinými vlastnostmi události.

KromÄ› toho třída události popisuje, o „jaký druh události“ jde, a je-li událost naÅ¡e vlastní, mÄ›li bychom používat CustomEvent prostÄ› proto, aby bylo zÅ™ejmé, co je zač.

událost.preventDefault()

Mnoho událostí prohlížeče má „standardní akci“, např. navigaci na odkaz, zahájení výběru a podobně.

U nových, vlastních událostí samozřejmě žádné standardní akce prohlížeče nejsou, ale kód, který takovou událost vyvolává, může mít vlastní plány, co bude po spuštění události dělat.

Voláním událost.preventDefault() může handler události poslat signál, že tyto akce by mÄ›ly být zruÅ¡eny.

V takovém případÄ› volání elem.dispatchEvent(událost) vrátí false. A kód, který událost vyvolal, ví, že by nemÄ›l pokračovat.

Podívejme se na praktický příklad – skrývající se králík (ale může to být i zavírající se menu nebo cokoli jiného).

Níže vidíte #králík a funkci skryj(), která na nÄ›m vyvolává událost "skryj", aby oznámila vÅ¡em stranám, které o to mají zájem, že se králík hodlá skrýt.

Jakýkoli handler může této události naslouchat pomocí králík.addEventListener('skryj',...) a pak, je-li to nutné, zruÅ¡it akci voláním událost.preventDefault(). Pak králík nezmizí:

<pre id="králík">
  |\   /|
   \|_|/
   /. .\
  =\_Y_/=
   {>o<}
</pre>
<button onclick="skryj()">Skryj()</button>

<script>
  function skryj() {
    let událost = new CustomEvent("skryj", {
      cancelable: true // bez tohoto přepínače preventDefault nefunguje
    });
    if (!králík.dispatchEvent(událost)) {
      alert('Akce byla zakázána handlerem');
    } else {
      králík.hidden = true;
    }
  }

  králík.addEventListener('skryj', function(událost) {
    if (confirm("Volat preventDefault?")) {
      událost.preventDefault();
    }
  });
</script>

Prosíme vÅ¡imnÄ›te si, že událost musí mít pÅ™epínač cancelable: true, jinak bude volání událost.preventDefault() ignorováno.

Události v událostech jsou synchronní

Události se obvykle zpracovávají ve frontÄ›. To znamená, že jestliže prohlížeč zpracovává onclick a objeví se nová událost, napÅ™. pohyb myÅ¡i, pak se její zpracování uloží do fronty a odpovídající handlery mousemove budou volány po skončení zpracování onclick.

Pozoruhodnou výjimkou je situace, kdy je událost vyvolána zevnitÅ™ jiné události, napÅ™. pomocí dispatchEvent. Takové události se zpracují okamžitÄ›: volají se handlery nové události a teprve pak se obnoví zpracování aktuální události.

Například v následujícím kódu se událost otevři-menu spustí bÄ›hem události onclick.

Bude zpracována okamžitÄ› bez čekání na skončení handleru onclick:

<button id="menu">Menu (klikni na mÄ›)</button>

<script>
  menu.onclick = function() {
    alert(1);

    menu.dispatchEvent(new CustomEvent("otevři-menu", {
      bubbles: true
    }));

    alert(2);
  };

  // přepíná mezi 1 a 2
  document.addEventListener('otevři-menu', () => alert('vnořená'));
</script>

Pořadí výstupů je: 1 → vnořená → 2.

Prosíme vÅ¡imnÄ›te si, že vnoÅ™ená událost otevři-menu se zachytává v document. PÅ™edávání a zpracování vnoÅ™ené události skončí dříve, než se proces vrátí do vnÄ›jšího kódu (onclick).

Neplatí to jen pro dispatchEvent, jsou i jiné případy. Jestliže handler události volá metody, které spouÅ¡tÄ›jí jiné události, budou také zpracovány synchronnÄ›, vnoÅ™eny do sebe.

ŘeknÄ›me, že se nám to nelíbí. Chceme, aby byla nejdříve zcela zpracována onclick, nezávisle na otevři-menu nebo jiných vnoÅ™ených událostech.

Pak můžeme buď umístit dispatchEvent (nebo jiné volání spouÅ¡tÄ›jící událost) na konec onclick, nebo, což je možná lepší, zabalit je do setTimeout s nulovou prodlevou:

<button id="menu">Menu (klikni na mÄ›)</button>

<script>
  menu.onclick = function() {
    alert(1);

    setTimeout(() => menu.dispatchEvent(new CustomEvent("otevři-menu", {
      bubbles: true
    })));

    alert(2);
  };

  document.addEventListener('otevři-menu', () => alert('vnořená'));
</script>

Nyní se dispatchEvent spustí asynchronnÄ› po skončení výkonu aktuálního kódu, včetnÄ› menu.onclick, takže handlery událostí budou zcela oddÄ›lené.

Pořadí výstupů se změní na: 1 → 2 → vnořená.

Shrnutí

Abychom generovali událost z kódu, musíme nejprve vytvořit objekt události.

Obecný konstruktor Event(název, možnosti) pÅ™ijímá libovolný název události a objekt možnosti se dvÄ›ma vlastnostmi:

• bubbles: true, pokud událost má bublat.
• cancelable: true, pokud má fungovat událost.preventDefault().

Jiné konstruktory nativních událostí, napÅ™. MouseEvent, KeyboardEvent a podobnÄ›, pÅ™ijímají vlastnosti specifické pro přísluÅ¡ný typ události, například clientX pro události myÅ¡i.

Pro vlastní události bychom mÄ›li používat konstruktor CustomEvent. Ten má další možnost nazvanou detail, do níž bychom mÄ›li uložit data specifická pro naÅ¡i událost. K nim pak vÅ¡echny handlery budou moci pÅ™istupovat pomocí událost.detail.

PÅ™estože je technicky možné generovat události prohlížeče, napÅ™. click nebo keydown, mÄ›li bychom je používat s velkou obezÅ™etností.

Neměli bychom generovat události prohlížeče jen jako trik pro spuštění handlerů. To je ve většině případů špatná architektura.

Nativní události můžeme generovat:

• Jako oÅ¡klivý způsob, jak pÅ™inutit knihovny tÅ™etích stran fungovat tak, jak potÅ™ebujeme, pokud nám neposkytují jinou možnost interakce.
• Pro automatické testování, abychom ve skriptu „klikli na tlačítko“ a vidÄ›li, zda rozhraní správnÄ› reaguje.

Vlastní události s našimi vlastními názvy se často generují z architektonických důvodů, aby signalizovaly, co se děje uvnitř našich menu, posuvníků, kolotočů a podobně.