WebUI X Config Documentation

The WebUIConfig class defines the configuration settings for the WebUI. Below is a detailed explanation of each property.

Location:

• /data/adb/modules/<ID>/webroot/config.json
• /data/adb/modules/<ID>/webroot/config.mmrl.json

Config.ts

import { Require } from "./Require";

type BackInterceptor = "native" | "javascript" | boolean | null;
type RefreshInterceptor = "native" | "javascript" | null;

export interface Config {
  /**
   * Configuration for required dependencies for the WebUI.
   */
  require: Require;

  /**
   * List of permissions required by the Web UI.
   */
  permissions: Array<string>;

  /**
   * Whether the WebUI should fallback to the `historyFallbackFile` if a route is not found.
   * @default false
   */
  historyFallback: boolean;

  /**
   * The title of the WebUI window. If null, the default title of the underlying platform will be used.
   */
  title: string | null;

  /**
   * The path to the icon of the WebUI. If null, the default icon of the underlying platform will be used.
   */
  icon: string | null;

  /**
   * Whether the WebUI window should be resizable.
   * @default true
   */
  windowResize: boolean;

  /**
   * @deprecated
   * Use `backInterceptor` instead.
   * Whether the WebUI should handle the back button/gesture events.
   * @default true
   */
  backHandler: boolean | null;

  /**
   * The interceptor to use for the back button/gesture events. If set to `null` or `false`, the default behavior of the underlying platform will be used.
   * @default null
   */
  backInterceptor: BackInterceptor;

  /**
   * Whether the WebUI should handle the refresh button/gesture events. Requires `pullToRefresh` to be enabled.
   * @default null
   */
  refreshInterceptor: RefreshInterceptor;

  /**
   * Whether the WebUI should support pull-to-refresh functionality.
   * This is typically used in mobile web applications to allow users to refresh the content by pulling down.
   * @default true
   */
  pullToRefresh: boolean;

  /**
   * Whether the WebUI should show a confirmation dialog when the user tries to exit.
   * @default true
   */
  exitConfirm: boolean;

  /**
   * The file to use as a fallback when `historyFallback` is enabled.
   * @default "index.html"
   */
  historyFallbackFile: string;
}

Require.ts

interface Package {
  code: number;
  packageName: string | Array<string>;
  supportText: string | null;
  supportLink: string | null;
}

/**
 * @deprecated
 */
interface Version {
  required: number;
  supportText: string | null;
  supportLink: string | null;
}

export interface Require {
  packages: Array<Package>;
  /**
   * @deprecated
   * Use `packages` instead.
   */
  version: Version;
}