Sparkling
  • English

      • API Overview

      Configuration

      APIDescription
      AppConfigThe app.config.ts schema — wraps lynx.config.ts with Sparkling-specific fields

      Sparkling Lynx

      APIs for Lynx bundles running inside Sparkling containers.

      APIDescriptionWeb
      GlobalPropsRuntime globals injected by the native SDK (lynx.__globalProps)-
      SchemeThe unified hybrid://... URL format for opening pages/containers-
      NavigationRouter helpers for opening/closing pages from Lynx/JSYes
      StorageKey-value storage helpers for Lynx/JSYes
      MediaMedia helpers for choosing, uploading, downloading, and saving filesYes

      Sparkling SDK

      Native SDK APIs for hosting Sparkling content in your app.

      APIDescription
      AndroidAndroid SDK for initializing and hosting Sparkling containers
      iOSiOS SDK for initializing and hosting Sparkling containers

      Sparkling Method SDK

      The native bridge layer that enables JS ↔ native method calls.

      APIDescription
      AndroidNative bridge implementation for Android
      iOSNative bridge implementation for iOS
      TypeScriptJS-side pipe that all method packages are built on
      Response codesShared method response code convention