OrbitoViewEngine – Dokumentacja

Dokumentacja automatycznie wygenerowana z komentarzy [OVE-DOC]
Data generacji: 25.08.2026, 14:54:01

OrbitoViewEngine to silnik widoków oparty na Custom Elements (Web Components). Pozwala budować całe interfejsy użytkownika deklaratywnie — opisując je schematem JSON/YAML, bez pisania kodu komponentów. Definiujesz co ma się pojawić, a silnik zajmuje się renderowaniem, reaktywnością i obsługą zdarzeń.

Od czego zacząć

Nowy w silniku? Polecana kolejność lektury:

BaseView – Klasa bazowa — fundament każdego widoku: cykl życia (onLoad, onEvent, onKey), reaktywność i warunkowe renderowanie (renderIf).
Zmienne (VarStore) — jak przekazywać i współdzielić stan między widokami (poziomy view / page / global).
Listy i notacja .$ — jak renderować kolekcje danych i odwoływać się do bieżącego elementu listy.
Szablony Handlebars — składnia {{ }} i helpery.
Dostępne Akcje (ActionHandler) — co widoki mogą robić w reakcji na zdarzenia użytkownika.
Tabele danych — źródła danych, kolumny, podsumowania i edycja wiersza.
Edycja danych — model draftu, opis pól i sekcja inlineedit.
Kontrolki wartości — wspólny kontrakt getValue() / setValue() i lista kontrolek.
Warianty stylistyczne — wygląd opisany opcjami zamiast klasami CSS.
Komponenty i sloty — reużywalne fragmenty schematu z propsami i slotami.
Pliki, kamera i schemat z serwera — podgląd i wybór plików, zdjęcia oraz walidacja zdalnego schematu.

Przewodnik

Widoki

Pełna lista udokumentowanych widoków (po jednym pliku na widok):

Aby zaktualizować dokumentację uruchom:

npm run generate-docs