Sparkling
  • English

      • Scheme

      Sparkling pages/containers are opened by a hybrid://... URL. This document defines the unified scheme format and parameters that are applied on both Android and iOS.

      Hosts (container types)

      Sparkling supports multiple hybrid:// hosts:

      • hybrid://lynxview_page: Lynx page container (recommended)
      • hybrid://lynxview: legacy alias of lynxview_page (still supported)
      • hybrid://lynxview_card: Lynx card container (currently Android)
      • hybrid://webview: WebView container

      Unless otherwise noted, examples below use lynxview_page.

      Format

      hybrid://lynxview_page?bundle=<bundlePath>[&title=<title>][&hide_nav_bar=1][&title_color=<color>][&container_bg_color=<color>][&force_theme_style=light|dark]
      • hybrid://lynxview_page: host type for Sparkling Lynx page containers (recommended).
      • bundle: points to the .lynx.bundle you ship inside the app.

      Encoding rules

      • Always URL-encode parameter values.
      • If you pass hex colors, # must be encoded as %23 (otherwise it becomes a URL fragment).
      • Prefer building schemes with a query builder (URLSearchParams, Uri.Builder, etc.) instead of manual string concatenation.

      Example with encoded colors:

      hybrid://lynxview_page?bundle=main.lynx.bundle&title=Home&title_color=%23000000&container_bg_color=%23ffffff

      Parameters (cross-platform)

      Only the following parameters are guaranteed to have an effect on both Android and iOS.

      ParamTypeDefaultMeaning
      bundlestring (required)-Lynx bundle path/name to load (must exist in app assets/resources).
      titlestringplatform defaultContainer title (usually shown in the navigation bar).
      hide_nav_bar0/10Hide the navigation bar when set to 1.
      title_color#RRGGBB (encoded)platform defaultTitle text color. Use 6-digit RGB only; see “Color format”.
      container_bg_color#RRGGBB (encoded)platform defaultContainer background color. Use 6-digit RGB only; see “Color format”.
      force_theme_stylelight | darksystem defaultForce light/dark theme for container-level theming and theme-dependent props.
      nav_bar_color#RRGGBB (encoded)platform defaultNavigation bar background color. Use 6-digit RGB only.
      hide_status_bar0/10Hide the status bar when set to 1.
      trans_status_bar0/10Use transparent status bar when set to 1.
      hide_loading0/10Hide the loading view when set to 1.
      loading_bg_color#RRGGBB (encoded)platform defaultLoading view background color. Use 6-digit RGB only.
      hide_error0/10Hide the error view when set to 1.

      Color format (cross-platform)

      Use 6-digit RGB hex colors: #RRGGBB (encode # as %23 in a URL).

      Do not use 8-digit hex colors for transparency in the scheme (Android and iOS interpret 8-digit hex differently).

      Examples

      Minimal:

      hybrid://lynxview_page?bundle=main.lynx.bundle

      With title:

      hybrid://lynxview_page?bundle=main.lynx.bundle&title=Home

      Hide navigation bar:

      hybrid://lynxview_page?bundle=main.lynx.bundle&hide_nav_bar=1

      Force dark theme:

      hybrid://lynxview_page?bundle=main.lynx.bundle&force_theme_style=dark