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: { /* ... */ }
};
};
| Parametr | Opis |
|---|---|
body | Dane z ciała żądania (POST) |
params | Parametry ś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
| Typ | Opis | Kiedy używać |
|---|---|---|
ove | Deklaratywny opis widoku w JSON – renderowany przez OrbitoViewEngine | Zalecany – spójny wygląd bez znajomości HTML/CSS |
html | Czysty HTML zwracany jako string | Gdy potrzebna pełna kontrola nad strukturą HTML |
vue | Komponent Vue | Gdy 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
