Orbito - Dokumentacja modułówOrbito - Dokumentacja modułów
Wprowadzenie
Pierwsze kroki
API
Komunikacja
Widoki
Wdrożenie
Społeczność
For AI agents
Wprowadzenie
Pierwsze kroki
API
Komunikacja
Widoki
Wdrożenie
Społeczność
For AI agents
  • Widoki

    • Widoki stron modułu
    • OrbitoViewEngine (OVE)
    • Widoki HTML i Vue
    • Rozszerzanie widoków przez hooki

Widoki stron modułu

Moduły Orbito mogą rejestrować własne strony interfejsu użytkownika dostępne z poziomu panelu administracyjnego. Każda strona to funkcja handler zwracająca opis widoku – platforma zajmuje się jego renderowaniem.

Rejestracja strony

Strony rejestruje się w index.js za pomocą Pages.registerPage:

const { Pages } = require('@orbito/api-lib');

Pages.registerPage('/config', 'Konfiguracja', require('./pages/config'));
Pages.registerPage('/config/:shopId', 'Edycja konfiguracji', require('./pages/configEdit'));
  • Ścieżki bez parametrów (np. /config) są widoczne dla użytkownika i może on przypiąć je do swojej nawigacji.
  • Ścieżki z parametrami (np. /config/:shopId) służą do nawigacji wewnętrznej między widokami modułu.

Handler strony

Każdy handler to funkcja async eksportowana z pliku strony:

module.exports = async function(body, params) {
    return {
        type: 'ove',   // lub 'html', 'vue'
        template: { /* ... */ }
    };
};
ParametrOpis
bodyDane z ciała żądania (POST)
paramsParametry ścieżki (np. params.shopId dla /config/:shopId)

Brak companyId

Handler nie otrzymuje companyId – strona jest zawsze renderowana w kontekście firmy, do której należy kontener modułu. Szczegóły w Kontekst firmy.

Typy widoków

TypOpisKiedy używać
oveDeklaratywny opis widoku w JSON – renderowany przez OrbitoViewEngineZalecany – spójny wygląd bez znajomości HTML/CSS
htmlCzysty HTML zwracany jako stringGdy potrzebna pełna kontrola nad strukturą HTML
vueKomponent VueGdy potrzebna reaktywność po stronie klienta

Szczegółowa dokumentacja

  • OrbitoViewEngine (OVE) – zalecany silnik widoków, opis komponentów i przykłady
  • Widoki HTML i Vue – alternatywne typy dla zaawansowanych przypadków
  • Dokumentacja komponentów OVE – pełna lista komponentów z parametrami
Ostatnio zaktualizowano:: 15.07.2026, 08:14
Contributors: Wiktor Koźmiński
Next
OrbitoViewEngine (OVE)