pantoken / renderers/web-components/src / register

Függvény: register()

register(target?, options?): void

Alfa

Regisztrálja a pantoken egyéni elemeket. Nem működik, ha nincs DOM (SSR / build), így ez a modul biztonságosan importálható bárhol.

Paraméterek

target?

ElementRegistry | undefined

A regisztráció, amelybe definiálni kell (alapértelmezés: globalThis.customElements).

options?

prefix beállítja a tag prefixet, tükrözve a CSS réteget: adjon meg egy nem üres karakterláncot, mint a x a <x-icon> számára. A prefix mindig alkalmazott (az egyéni elem nevének tartalmaznia kell egy kötőjelet), így az elhagyott, üres vagy nullish prefix az alapértelmezett instui (<instui-icon>) értékre esik vissza. only korlátozza a regisztrációt a ELEMENTS alapnevek egy részhalmazára — beágyazott render függőségei automatikusan bekerülnek, így { only: ["date-time-input"] } szintén definiálja date-input és calendar. Hagyja ki a only-t az összes elem regisztrálásához (alapértelmezett).

prefix?

string | null

only?

readonly string[]

Visszatérés

void

Példa

import { register } from "@pantoken/web-components";
import "@pantoken/css"; // defines the --instui-* custom properties the elements read

register(); // <instui-button>, <instui-icon>, …
register(customElements, { prefix: "x" }); // <x-button>, <x-icon>, …
register(customElements, { only: ["button", "alert"] }); // just those two