Skip to content

API referencia

HTML atribúty

AtribútTypPopis
srcstringURL alebo cesta k .rea alebo .reast súboru

Udalosti

Všetky udalosti sú inštancie CustomEvent s typovaným detail.

rea-loaded

Vyvolaná po sparsovaní príbehu, keď je pripravený na vykreslenie.

typescript
interface ReaLoadedDetail {
  title: string;
  partCount: number;
}

rea-choice

Vyvolaná keď čitateľ vyberie voľbu.

typescript
interface ReaChoiceDetail {
  label: string;
  index: number;
}

rea-complete

Vyvolaná keď príbeh dosiahne terminálny uzol (žiadny ďalší obsah na zobrazenie).

typescript
interface ReaCompleteDetail {
  storyId?: string;
}

rea-error

Vyvolaná pri chybe parsovania, načítavania alebo runtime chybe.

typescript
interface ReaErrorDetail {
  code: string;
  message: string;
}

JavaScript API

Po pripojení elementu do DOM máte prístup k týmto metódam a vlastnostiam:

Vlastnosti

VlastnosťTypPopis
storyReaDocument | nullSparsovaný dokument príbehu
engineStoryEngine | nullBežiaca inštancia enginu

Metódy

MetódaPopis
load(src: string)Načítať príbeh z URL
reset()Resetovať príbeh na začiatok

Subpath exporty

Balík @reast/engine sprístupňuje viaceré subpath importy:

ExportPopis
@reast/engineHlavný barrel — bezpečný pre Node (parser, loader, runtime, errors, types)
@reast/engine/parserREA lexer + parser
@reast/engine/loaderLoader .reast archívov (extrakcia, dešifrovanie, manifest)
@reast/engine/runtimeStoryEngine, evaluátor výrazov, správca stavu
@reast/engine/player<reast-player> webový komponent (iba prehliadač)
@reast/engine/geoGeo-pozičné utility
@reast/engine/errorsTriedy chýb a kódy
@reast/engine/typesTypeScript definície typov