Skip to content

Konfigurace ​

Všechny volby jsou v config/pwa.php (publikuje php artisan pwa:install nebo php artisan vendor:publish --tag="pwa::config"). Změny configu mění verzi service workeru, takže po nasazení s pwa:build se zařízení aktualizují sama.

Proměnné prostředí ​

ProměnnáKlíčVýchozí
PWA_ENABLEDenabledtrue mimo APP_ENV=local
PWA_NAMEnameAPP_NAME
PWA_SHORT_NAMEshort_namenull (= name)
PWA_DESCRIPTIONdescriptionnull
PWA_DISPLAY_STRATEGYdisplay.strategyoverride
PWA_KILL_SWITCH_STOREsw.kill_switch_storenull (výchozí cache store)
PWA_LOG_CHANNELtelemetry.channelnull (výchozí log)
PWA_PUSH_ENABLEDpush.enabledfalse
PWA_VAPID_SUBJECTpush.vapid.subjectAPP_URL
PWA_VAPID_PUBLIC_KEY, PWA_VAPID_PRIVATE_KEYpush.vapid.*null (pwa:push:vapid)

Obecné ​

KlíčTypVýchozíPopis
enabledboolmimo local trueZapne service worker. Při false klient existující SW odregistruje a /sw.js vrací samodestrukční SW. Manifest a komponenty fungují dál.
route_prefixstringpwaPrefix interních rout (/pwa/session, /pwa/ping, /pwa/client.js, /pwa/telemetry).

Identita ​

KlíčTypVýchozíPopis
namestringAPP_NAMEPlný název v instalačním dialogu a seznamu aplikací.
short_name?stringnullPod ikonou na ploše; do 12 znaků. Bez něj se použije name.
description?stringnullPopis v instalačním dialogu (Chromium).
idstring/Identita aplikace. Po vydání neměnit: změna = nová aplikace, stará zůstane nainstalovaná.
start_urlstring/?source=pwaKam se aplikace otevře. source=pwa označí session jako nainstalovanou aplikaci (ne pro remember-me).
scopestring/Které URL patří aplikaci. start_url musí ležet uvnitř.

Texty name, short_name a description jdou přeložit v lang/vendor/pwa/{locale}/manifest.php (klíče name, short_name, description).

Zobrazení ​

KlíčTypVýchozíPopis
display.strategyoverride, adaptive, fixedoverrideViz Režim zobrazení.
display.valuestringstandaloneHodnota display (standalone, minimal-ui, fullscreen, browser).
display.overridelist['minimal-ui']display_override pro strategii override.
display.desktopstringminimal-uiRežim pro desktop u strategie adaptive.
orientation?stringnullNapř. portrait; většinou nenastavovat (tablety).
desktop_nav.enabledbooltrueVykreslovat <x-pwa::nav/>.
desktop_nav.min_widthint900Od jaké šířky okna se komponenta považuje za desktop.

Vzhled a ikony ​

KlíčTypVýchozíPopis
theme.lighthex#0d6efdtheme_color a světlá theme-color; akcent offline a údržby.
theme.darkhex#0b1220theme-color pro tmavý režim.
theme.accent_darkhex#5b9dffAkcent obrazovek offline a údržby v tmavém režimu.
theme.backgroundhex#ffffffbackground_color (splash na Androidu), pozadí maskable a iOS ikony.
icons.source?stringnullVýchozí zdroj pro pwa:icons.
icons.pathstringpwa/iconsSložka ikon v public/.
icons.sizeslist<int>[192, 512]Velikosti icon-{size}.png.
icons.maskable_paddingfloat0.1Okraj maskable ikony (bezpečná zóna je 80 %).
icons.splash.background?hexnullPozadí úvodních obrazovek iOS; null = theme.background.
icons.splash.dark_background?hexnullPřidá varianty pro prefers-color-scheme: dark s tímto pozadím.
icons.splash.icon_sizefloat0.3Hrana ikony jako podíl kratší hrany obrazovky.
icons.splash.orientationslist<string>['portrait', 'landscape']Orientace, které se vytvoří.
icons.splash.devices?list<string>nullKlíče AppleDevices::SCREENS; null = všechny iPhony a iPady.
screenshotslist[]Screenshoty pro bohatší instalační dialog (src, sizes, type, form_factor), viz Manifest.

Integrace do systému ​

KlíčTypVýchozíPopis
categorieslist[]Kategorie obchodů a launcherů, např. ['business'].
shortcutslist[]Zkratky na ikoně: ['name' => …, 'url' => …, 'icon' => …].
share_target?arraynullCelý objekt share_target; pohodlněji přes Pwa::manifest()->shareTarget().
file_handlerslist[]Otevírání souborů z OS (Chromium desktop).
protocol_handlerslist[]Vlastní schémata web+….
launch_handlerarrayclient_mode: [navigate-existing, auto]Jak se otevře aplikace, která už běží.
scope_extensionslist[]Další domény jedné aplikace; vyžaduje /.well-known/web-app-origin-association na nich.
localeslist[]Jazyky manifestu včetně výchozího: *_localized členy (Chromium 147+) a odkaz ?lang= podle jazyka stránky.

Service worker ​

KlíčTypVýchozíPopis
sw.urlstring/sw.jsURL service workeru. Nikdy nedávejte soubor se stejným názvem do public/.
sw.importlist[]Skripty načtené přes importScripts před runtime (push systém, Sentry). Jejich obsah mění verzi SW.
sw.extendlist[]Skripty načtené po runtime; mají self.PwaWorker (vlastní trasy a strategie), viz Service worker.
sw.vite_manifeststringbuild/manifest.jsonVite manifest v public/ pro precache.
sw.build_directorystringbuildPrefix assetů Vite (cache-first).
sw.compiled_pathstringbootstrap/cache/pwaKam pwa:build uloží sestavený SW.
sw.kill_switch_store?stringnullCache store pro pwa:disable; při více serverech sdílený (Redis, databáze).

Cache ​

KlíčTypVýchozíPopis
manifest.resolverslist[]Třídy ManifestResolver (z kontejneru) pro manifest podle požadavku, viz Manifest.
cache.navigation_timeoutint (s)3Po kolika sekundách pomalé sítě použít stránku z cache.
cache.ruleslist[]Pravidla cache (match, destination, strategy, cache, max_entries, max_age, timeout, shared), viz Pravidla cache.
cache.apilist[]Zkratka: GET cesty (s *) s network-first, např. ['/api/catalog*'].
cache.images.enabledbooltrueVýchozí pravidlo pro obrázky a fonty (stale-while-revalidate).
cache.images.max_entriesint120Limit obrázků a fontů v cache.
cache.images.max_ageint (s)30 dníStarší obrázek se načte znovu (offline se použije i starší).
cache.never_cachelistlogin, logout, register, broadcasting, livewire, sanctum, /pwa/*Cesty, které SW nikdy neuloží ani nezařadí do fronty; fetch/XHR jen propustí na síť a přečte z nich identitu uživatele.

Offline ​

KlíčTypVýchozíPopis
offline.enabledbooltrueOffline obrazovka a její routa.
offline.routestring/offlineURL offline obrazovky (precache).
offline.precachelist[]Další URL do precache, např. ['/manifest.webmanifest', '/img/logo.svg'].
offline.queuebooltrueUkládat POST/PUT/PATCH/DELETE při výpadku sítě do fronty.
offline.warm.urlslist<string>[]Stránky stažené dopředu; pro konkrétního uživatele Pwa::warmUsing(), viz Předehřátí.
offline.warm.maxint20Nejvyšší počet stránek na jedno předehřátí.
offline.warm.intervalint60Minuty mezi automatickými předehřátími (přihlášení předehřeje vždy).

Session ​

KlíčTypVýchozíPopis
session.standalone_rememberbooltruepwa.remember vynutí remember-me v nainstalované aplikaci.
session.keepalive_minutesint10Interval keep-alive, když je aplikace vidět (0 = jen při návratu).
session.refresh_csrfbooltrueObnovovat CSRF token a opakovat fetch po 419.
session.remember_fieldstringrememberNázev pole remember-me ve formuláři přihlášení.

Údržba ​

KlíčTypVýchozíPopis
maintenance.message?stringnullZpráva obrazovky údržby (jinak přeložený výchozí text).
maintenance.until?stringnullOčekávaný konec (ISO 8601); nastavuje pwa:down --until.
maintenance.retryint (s)60Výchozí Retry-After a interval kontrol (15–300 s).
maintenance.refresh?intnullVýchozí --refresh pro pwa:down.

Instalace, telemetrie, adaptéry ​

KlíčTypVýchozíPopis
install.min_visitsint2Od kolikáté návštěvy ukazovat <x-pwa::install/>.
install.dismiss_daysint30Jak dlouho po odmítnutí výzvu neukazovat.
install.ios_hintbooltrueNápověda „Sdílet → Přidat na plochu“ na iPhonu a iPadu.
telemetry.logbooltrueZapisovat TelemetryReceived do logu; vypněte, když události zpracováváte sami (Události).
telemetry.enabledbooltruePosílat chyby service workeru na /pwa/telemetry.
telemetry.channel?stringnullLog kanál; neexistující kanál = výchozí log.
telemetry.max_eventsint20Max. událostí v jednom požadavku.
adapters.livewirebooltrueAdaptér pro Livewire 3.
adapters.inertiabooltrueAdaptér pro Inertia.
adapters.reload_on_resumeboolfalseInertia reload() po návratu do aplikace.

Web push ​

Viz Push notifikace.

KlíčTypVýchozíPopis
push.enabledboolfalseVolitelný modul push: routy pro odběry, Pwa.push, push listenery ve workeru.
push.vapid.subjectstringAPP_URLKontakt pro push služby: mailto: nebo https://.
push.vapid.public_key, push.vapid.private_key?stringnullZapíše pwa:push:vapid; nové klíče zneplatní všechny odběry.
push.modelclass-stringPush\PushSubscriptionVlastní model musí dědit z tohoto.
push.tablestringpwa_push_subscriptionsTabulka publikované migrace.
push.middlewarelist['auth']Middleware rout pro odběry (po web, omezeno na 20/min).
push.max_subscriptionsint10Zařízení na vlastníka; nejdéle nepoužité se odebere první.
push.endpoints?listFCM, Mozilla, Windows, AppleHosty push služeb, které server přijme a na které posílá (zástupný znak *); null = jakýkoli https host.
push.ttlint (s)2419200Jak dlouho push služba drží nedoručenou zprávu (28 dní).
push.urgencystringnormalvery-low, low, normal, high.
push.icon, push.badge?stringnullVýchozí hodnoty zpráv; null = icon-192.png a monochrome-512.png z icons.path, pokud existují.
push.handle_in_workerbooltrueWorker zobrazuje notifikace a obsluhuje kliknutí; false, když to dělá skript v sw.import.

Released under the MIT License.