Skip to main content

Cross-Platform Runtime Model

Hosanna separates the app layout expression from the concrete host platform. Product code should usually ask what kind of experience it is rendering (tv, web, phone, or tablet) and use capability checks for platform services, rather than branching directly on a device name.

Runtime Vocabulary

  • expression: app/layout intent: tv, web, phone, or tablet.
  • platformId: concrete host target such as roku, web, web-pwa, apple-native, apple-native-ios, or android-native.
  • runtime: renderer family: roku-scenegraph, web-dom, apple-native, or android-native.
  • os: host OS family such as roku, web, ios, android, tvos, or androidtv.
  • formFactor: physical UX class: tv, desktop, phone, or tablet.
  • orientation: current design-surface orientation. It does not select a platform or config by itself.

This model lets TV and native mobile targets stay on their native renderers while sharing the same app-level expression model. Legacy Capacitor/WebView shells are outside the current capability-ID contract; native Apple and Android launchers are the default path for current development.

Independent resolution lanes for runtime identity, presentation defaults, live layout, BuildConfig, and AppConfigIndependent resolution lanes for runtime identity, presentation defaults, live layout, BuildConfig, and AppConfig

Runtime selection, presentation defaults, live measurements, BuildConfig, and AppConfig have related inputs but remain distinct resolution paths.

Config Variants

The base config remains assets/meta/app.config.json. Variants use app.config.<name>.json, for example:

  • app.config.phone.json
  • app.config.tablet.json
  • app.config.web.json
  • app.config.roku.json
  • app.config.mobile.json

Runtime selection is expression-first:

  1. Explicit appConfig launch/query override.
  2. Expression variant such as app.config.phone.json.
  3. Platform variant such as app.config.web.json, when no expression variant exists.
  4. Base app.config.json.

Device presets expand into expressions. For example, ?device=iphone-15 selects expression=phone, and ?device=galaxy-tab-s9 selects expression=tablet; the device name does not directly select a config file.

Variants can inherit another file with root-level $extendFile:

{
"$extendFile": "./app.config.json",
"appSettings": {
"configVariant": "phone"
}
}

Objects merge deeply with child values winning. Arrays and scalar values replace the parent value. $extends keeps its existing in-file style-reference meaning and is separate from $extendFile.

Device Metrics

Use deviceLayout for cross-platform layout decisions in views. Avoid scattering direct window, user-agent, or platform checks through view code.

Important fields include:

  • expression: active app/layout expression.
  • deviceLayoutOrientation: portrait or landscape design orientation.
  • deviceDpi: physical pixel width for the active design surface.
  • devicePreset: optional preset name that supplied the metrics.
  • resolutionInfo: resource-resolution suffix, scale, width, and height.
  • screenInfo: raw host viewport, screen, DPR, and safe-area values.
  • layoutInfo: the shared view-facing object also available as injected deviceLayout.

screenInfo remains the raw platform measurement contract. It contains only viewport size, host screen size, device pixel ratio, and safe-area insets. It should not accumulate derived layout flags or app-neutral content helpers.

deviceLayout / hosannaDevice.layoutInfo is the fast read model for views:

  • mode, expression, orientation, and booleans such as isTv, isPhone, isTablet, isPortrait, and isLandscape.
  • designWidth / designHeight for the active Hosanna design surface.
  • viewportWidth / viewportHeight and hostScreenWidth / hostScreenHeight.
  • Safe-area scalar fields and safe-area-aware padding/content bounds.
  • revision, incremented when exposed layout fields change.

The object identity is stable. Platform initializers register the deviceLayout IoC service explicitly, and HosannaDevice injects that same object as layoutInfo. Runtime metric changes mutate fields in place, so existing injected references stay current.

On Web, screenInfo comes from browser metrics and CSS safe-area env values. Native targets supply platform-native screen, cutout, and safe-area values through the same facade.

Web Launch Parameters

The web entry point accepts launch parameters for expression, device presets, design size, DPI, orientation, and input adapters:

http://localhost:5170/?device=iphone-15&orientation=portrait&adapters=touch,keyboard

Common parameters:

ParameterPurpose
`expression=tvweb
device=<preset>Expands to a known device profile, including expression, design size, DPI, adapter profile, and orientation defaults.
`orientation=portraitlandscape`
designWidth / designHeightLogical design surface size.
displayWidth / displayHeightAliases for designWidth / designHeight.
dpiPhysical output width. The renderer computes dpiScale = dpi / designWidth.
adapters=touch,keyboard,mouse,rokuLimits active input adapters.
showRemoteOverlay=trueShows the on-screen remote overlay. Use tiny or mini for compact overlays.

For existing TV-authored screens, keep the TV design surface and change the expression/output:

http://localhost:5170/?expression=phone&orientation=portrait&designWidth=1920&designHeight=1080&dpi=1179&adapters=touch,keyboard

For mobile-authored screens, use phone-sized logical values:

http://localhost:5170/?expression=phone&orientation=portrait&designWidth=393&designHeight=852&dpi=1179&adapters=touch,keyboard

See Web Expression, DPI, and Touch Input for input adapter and pointer-normalization details.

Orientation

Orientation changes go through the orientation controller instead of direct view mutation. The controller:

  1. Normalizes the target orientation.
  2. Checks whether the platform adapter supports it.
  3. Asks the app whether the change is allowed.
  4. Calls app and visible-view onWillChangeOrientation hooks.
  5. Updates device metrics and mutates the shared deviceLayout object.
  6. Calls app and visible-view onDidChangeOrientation hooks.
  7. Dispatches HosannaDeviceMetricsDidChange.
  8. Invalidates the root and visible navigation-controller view.

Views can override:

canChangeOrientation(event): boolean
onWillChangeOrientation(event): void
onDidChangeOrientation(event): void

Hosanna also dispatches HosannaOrientationWillChange and HosannaOrientationDidChange through the notification center. Use those notifications when a service or view needs to observe orientation without owning the visible root.

Non-orientation metric changes, such as web viewport resize or native safe-area changes, use the same metrics invalidation path. They refresh deviceLayout, dispatch HosannaDeviceMetricsDidChange, and invalidate the visible root even when orientation did not change.

Capabilities

Use platform capabilities for feature decisions. Current capability groups include:

  • video: HTML element playback, WebKit AirPlay, Chromecast Web Sender, native cast bridge, native media session.
  • input: touch, mouse, keyboard, and remote availability.
  • orientation: portrait lock and landscape-video support.
  • sharing and nativeSheets: native share/action-sheet availability.
  • notifications: permission, scheduling, registration, receipt, and action support.
  • storage: offline assets, filesystem, registry, and transfer support.
  • network and appLifecycle: status/events and native launch URL support.
  • purchases, casting, and auth: target service availability.
  • webView and scroll: embedded Web content and native scroll-host support.
  • layout: safe-area insets.

For platform-only APIs, expose the behavior through a platform capability or a small adapter boundary first. Avoid direct platformId or os branching in product views unless the branch sits behind that adapter.

Web and Samsung TV use the browser renderer. Current iOS/tvOS and Android targets use native renderer families. App code should still prefer expression and capability checks.

Cross-Platform Color Values

Color strings are normalized to #RRGGBBAA across renderers. #RRGGBB receives FF alpha, and 0xRRGGBB / 0xRRGGBBAA are accepted. Do not treat a leading FF or 00 as ARGB; alpha is last, so #FFFFFF00 is transparent white.

Talk to us