{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DioxusConfig",
"type": "object",
"properties": {
"android": {
"description": "Android-specific configuration.",
"$ref": "#/$defs/AndroidConfig"
},
"application": {
"$ref": "#/$defs/ApplicationConfig"
},
"background": {
"description": "Unified background mode configuration.\nBackground capabilities declared here are mapped to platform-specific\nconfigurations. Use `[ios]`, `[android]` sections for overrides.",
"$ref": "#/$defs/BackgroundConfig"
},
"bundle": {
"$ref": "#/$defs/BundleConfig"
},
"components": {
"$ref": "#/$defs/ComponentConfig"
},
"deep_links": {
"description": "Unified deep linking configuration.\nURL schemes and universal links declared here are mapped to platform-specific\nconfigurations. Use `[ios]`, `[android]`, `[macos]` sections for overrides.",
"$ref": "#/$defs/DeepLinkConfig"
},
"ios": {
"description": "iOS-specific configuration.",
"$ref": "#/$defs/IosConfig"
},
"linux": {
"description": "Linux-specific configuration.",
"$ref": "#/$defs/LinuxConfig"
},
"macos": {
"description": "macOS-specific configuration.",
"$ref": "#/$defs/MacosConfig"
},
"permissions": {
"description": "Unified permissions configuration.\nPermissions declared here are automatically mapped to platform-specific\nidentifiers (AndroidManifest.xml, Info.plist, etc.)",
"$ref": "#/$defs/PermissionsConfig"
},
"web": {
"$ref": "#/$defs/WebConfig"
},
"windows": {
"description": "Windows-specific configuration.",
"$ref": "#/$defs/WindowsConfig"
}
},
"$defs": {
"AndroidApplicationConfig": {
"type": "object",
"properties": {
"large_heap": {
"description": "Enable large heap.",
"type": [
"boolean",
"null"
]
},
"supports_rtl": {
"description": "RTL layout support.",
"type": [
"boolean",
"null"
]
},
"theme": {
"description": "Application theme.",
"type": [
"string",
"null"
]
},
"uses_cleartext_traffic": {
"description": "Enable cleartext (HTTP) traffic.",
"type": [
"boolean",
"null"
]
}
}
},
"AndroidConfig": {
"description": "Android-specific configuration.\n\nExample:\n```toml\n[android]\nmin_sdk = 24\ntarget_sdk = 34\nidentifier = \"com.example.myapp.android\" # Override bundle.identifier for Android\nfeatures = [\"android.hardware.location.gps\"]\n\n# Android signing configuration (previously in [bundle.android])\n[android.signing]\njks_file = \"keystore.jks\"\njks_password = \"password\"\nkey_alias = \"mykey\"\nkey_password = \"keypassword\"\n\n[android.permissions]\n\"android.permission.FOREGROUND_SERVICE\" = { description = \"Background service\" }\n```",
"type": "object",
"properties": {
"application": {
"description": "Application-level config.",
"$ref": "#/$defs/AndroidApplicationConfig"
},
"category": {
"description": "App category.\nOverrides `bundle.category` for Android builds.",
"type": [
"string",
"null"
]
},
"compile_sdk": {
"description": "Compile SDK version.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0
},
"copyright": {
"description": "Copyright notice.\nOverrides `bundle.copyright` for Android builds.",
"type": [
"string",
"null"
]
},
"features": {
"description": "Hardware/software features required.",
"type": "array",
"items": {
"type": "string"
}
},
"foreground_service_types": {
"description": "Foreground service types for background operations.\nValid values: \"camera\", \"connectedDevice\", \"dataSync\", \"health\", \"location\",\n\"mediaPlayback\", \"mediaProjection\", \"microphone\", \"phoneCall\", \"remoteMessaging\",\n\"shortService\", \"specialUse\", \"systemExempted\"",
"type": "array",
"items": {
"type": "string"
}
},
"gradle_dependencies": {
"description": "Gradle dependencies to add.",
"type": "array",
"items": {
"type": "string"
}
},
"gradle_plugins": {
"description": "Gradle plugins to apply.",
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"description": "Icons for the app.\nOverrides `bundle.icon` for Android builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"identifier": {
"description": "The app's identifier (e.g., \"com.example.myapp\").\nOverrides `bundle.identifier` for Android builds.",
"type": [
"string",
"null"
]
},
"intent_filters": {
"description": "Intent filters for deep linking.\nThese extend the unified `[deep_links]` configuration with Android-specific options.",
"type": "array",
"items": {
"$ref": "#/$defs/AndroidIntentFilter"
}
},
"lib_name": {
"description": "Native library name loaded by NativeActivity (without `lib` prefix and `.so` extension).\nDefaults to `\"main\"` (i.e. `libmain.so`). Override if you need a custom library name.",
"type": [
"string",
"null"
]
},
"long_description": {
"description": "Long description.\nOverrides `bundle.long_description` for Android builds.",
"type": [
"string",
"null"
]
},
"manifest": {
"description": "Path to custom AndroidManifest.xml to merge.",
"type": [
"string",
"null"
]
},
"min_sdk": {
"description": "Minimum SDK version.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0
},
"permissions": {
"description": "Additional Android permissions not in unified config.",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/RawPermission"
}
},
"proguard_rules": {
"description": "ProGuard rule files.",
"type": "array",
"items": {
"type": "string"
}
},
"publisher": {
"description": "The app's publisher.\nOverrides `bundle.publisher` for Android builds.",
"type": [
"string",
"null"
]
},
"queries": {
"description": "Queries for package visibility (required for Android 11+).\nSpecify packages or intents your app needs to query.",
"$ref": "#/$defs/AndroidQueries"
},
"raw": {
"description": "Raw XML injection points.",
"$ref": "#/$defs/AndroidRawConfig"
},
"resources": {
"description": "Additional resources to bundle.\nOverrides `bundle.resources` for Android builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"short_description": {
"description": "Short description.\nOverrides `bundle.short_description` for Android builds.",
"type": [
"string",
"null"
]
},
"signing": {
"description": "Android signing configuration for release builds.\nThis replaces the deprecated `[bundle.android]` section.",
"anyOf": [
{
"$ref": "#/$defs/AndroidSigningConfig"
},
{
"type": "null"
}
]
},
"target_sdk": {
"description": "Target SDK version.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0
},
"url_schemes": {
"description": "Additional URL schemes beyond unified `[deep_links]`.schemes.\nThese are merged with the unified schemes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AndroidIntentData": {
"description": "Android intent data specification.",
"type": "object",
"properties": {
"host": {
"description": "Host (e.g., \"example.com\").",
"type": [
"string",
"null"
]
},
"mime_type": {
"description": "MIME type.",
"type": [
"string",
"null"
]
},
"path": {
"description": "Path (exact match).",
"type": [
"string",
"null"
]
},
"path_pattern": {
"description": "Path pattern (with wildcards).",
"type": [
"string",
"null"
]
},
"path_prefix": {
"description": "Path prefix.",
"type": [
"string",
"null"
]
},
"port": {
"description": "Port number.",
"type": [
"string",
"null"
]
},
"scheme": {
"description": "URL scheme (e.g., \"https\", \"myapp\").",
"type": [
"string",
"null"
]
}
}
},
"AndroidIntentFilter": {
"description": "Android intent filter for deep linking.",
"type": "object",
"properties": {
"actions": {
"description": "Actions (e.g., \"android.intent.action.VIEW\").",
"type": "array",
"items": {
"type": "string"
}
},
"auto_verify": {
"description": "Auto-verify for App Links (requires HTTPS and assetlinks.json).",
"type": "boolean"
},
"categories": {
"description": "Categories (e.g., \"android.intent.category.DEFAULT\", \"android.intent.category.BROWSABLE\").",
"type": "array",
"items": {
"type": "string"
}
},
"data": {
"description": "Data specifications.",
"type": "array",
"items": {
"$ref": "#/$defs/AndroidIntentData"
}
}
}
},
"AndroidQueries": {
"description": "Android package visibility queries.",
"type": "object",
"properties": {
"intents": {
"description": "Intent actions to query.",
"type": "array",
"items": {
"$ref": "#/$defs/AndroidQueryIntent"
}
},
"packages": {
"description": "Package names to query.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"AndroidQueryIntent": {
"description": "Android query intent specification.",
"type": "object",
"properties": {
"action": {
"description": "Action (e.g., \"android.intent.action.SEND\").",
"type": "string"
},
"mime_type": {
"description": "MIME type (e.g., \"text/plain\").",
"type": [
"string",
"null"
]
},
"scheme": {
"description": "Data scheme (e.g., \"mailto\").",
"type": [
"string",
"null"
]
}
},
"required": [
"action"
]
},
"AndroidRawConfig": {
"type": "object",
"properties": {
"application": {
"description": "Raw XML inside `<application>` element.",
"type": [
"string",
"null"
]
},
"application_attrs": {
"description": "Raw attributes for `<application>` element.",
"type": [
"string",
"null"
]
},
"manifest": {
"description": "Raw XML to inject into manifest (after permissions).",
"type": [
"string",
"null"
]
}
}
},
"AndroidSettings": {
"type": "object",
"properties": {
"jks_file": {
"type": "string"
},
"jks_password": {
"type": "string"
},
"key_alias": {
"type": "string"
},
"key_password": {
"type": "string"
}
},
"required": [
"jks_file",
"jks_password",
"key_alias",
"key_password"
]
},
"AndroidSigningConfig": {
"description": "Android signing configuration for release builds.",
"type": "object",
"properties": {
"jks_file": {
"description": "Path to the Java keystore file.",
"type": "string"
},
"jks_password": {
"description": "Password for the keystore.",
"type": "string"
},
"key_alias": {
"description": "Alias of the key in the keystore.",
"type": "string"
},
"key_password": {
"description": "Password for the key.",
"type": "string"
}
},
"required": [
"jks_file",
"jks_password",
"key_alias",
"key_password"
]
},
"ApplicationConfig": {
"type": "object",
"properties": {
"android_main_activity": {
"description": "Use this file for the MainActivity.kt associated with the Android app.",
"type": [
"string",
"null"
]
},
"android_manifest": {
"description": "Use this file for the AndroidManifest.xml associated with the Android app.\n`dx` will merge any required settings into this file required to build the app",
"type": [
"string",
"null"
]
},
"android_min_sdk_version": {
"description": "Specified minimum sdk version for gradle to build the app with.",
"type": [
"integer",
"null"
],
"format": "uint32",
"minimum": 0
},
"asset_dir": {
"description": "The path where global assets will be added when components are added with `dx components add`",
"type": [
"string",
"null"
]
},
"ios_entitlements": {
"description": "Use this file for the entitlements.plist associated with the iOS app.",
"type": [
"string",
"null"
]
},
"ios_info_plist": {
"description": "Use this file for the info.plist associated with the iOS app.\n`dx` will merge any required settings into this file required to build the app",
"type": [
"string",
"null"
]
},
"macos_entitlements": {
"description": "Use this file for the entitlements.plist associated with the macOS app.",
"type": [
"string",
"null"
]
},
"macos_info_plist": {
"description": "Use this file for the info.plist associated with the macOS app.\n`dx` will merge any required settings into this file required to build the app",
"type": [
"string",
"null"
]
},
"name": {
"description": "Display name of the application",
"type": [
"string",
"null"
]
},
"out_dir": {
"type": [
"string",
"null"
]
},
"public_dir": {
"type": [
"string",
"null"
]
},
"tailwind_input": {
"type": [
"string",
"null"
]
},
"tailwind_output": {
"type": [
"string",
"null"
]
}
}
},
"BackgroundConfig": {
"description": "Unified background execution configuration.\n\nThis provides a cross-platform interface for background capabilities.\nPlatform-specific overrides can be configured in `[ios]` and `[android]` sections.\n\nExample:\n```toml\n[background]\nlocation = true\naudio = true\nfetch = true\n```",
"type": "object",
"properties": {
"audio": {
"description": "Background audio playback.\niOS: UIBackgroundModes \"audio\"\nAndroid: FOREGROUND_SERVICE_MEDIA_PLAYBACK",
"type": "boolean"
},
"bluetooth": {
"description": "Bluetooth LE accessories.\niOS: UIBackgroundModes \"bluetooth-central\" and \"bluetooth-peripheral\"\nAndroid: FOREGROUND_SERVICE_CONNECTED_DEVICE",
"type": "boolean"
},
"external-accessory": {
"description": "External accessory communication.\niOS: UIBackgroundModes \"external-accessory\"",
"type": "boolean"
},
"fetch": {
"description": "Background data fetch.\niOS: UIBackgroundModes \"fetch\"\nAndroid: WorkManager or foreground service",
"type": "boolean"
},
"location": {
"description": "Background location updates.\niOS: UIBackgroundModes \"location\"\nAndroid: ACCESS_BACKGROUND_LOCATION permission",
"type": "boolean"
},
"processing": {
"description": "Background processing tasks.\niOS: UIBackgroundModes \"processing\"\nAndroid: WorkManager",
"type": "boolean"
},
"remote-notifications": {
"description": "Remote push notifications.\niOS: UIBackgroundModes \"remote-notification\"\nAndroid: Firebase Cloud Messaging",
"type": "boolean"
},
"voip": {
"description": "VoIP calls.\niOS: UIBackgroundModes \"voip\"\nAndroid: FOREGROUND_SERVICE_PHONE_CALL",
"type": "boolean"
}
}
},
"BundleConfig": {
"type": "object",
"properties": {
"android": {
"anyOf": [
{
"$ref": "#/$defs/AndroidSettings"
},
{
"type": "null"
}
]
},
"category": {
"type": [
"string",
"null"
]
},
"copyright": {
"type": [
"string",
"null"
]
},
"deb": {
"anyOf": [
{
"$ref": "#/$defs/DebianSettings"
},
{
"type": "null"
}
]
},
"external_bin": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"file_version": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"identifier": {
"type": [
"string",
"null"
]
},
"long_description": {
"type": [
"string",
"null"
]
},
"macos": {
"anyOf": [
{
"$ref": "#/$defs/MacOsSettings"
},
{
"type": "null"
}
]
},
"original_file_name": {
"type": [
"string",
"null"
]
},
"publisher": {
"type": [
"string",
"null"
]
},
"resources": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"short_description": {
"type": [
"string",
"null"
]
},
"trademark": {
"type": [
"string",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
},
"windows": {
"anyOf": [
{
"$ref": "#/$defs/WindowsSettings"
},
{
"type": "null"
}
]
}
}
},
"ComponentConfig": {
"description": "Configuration for the `dioxus component` commands",
"type": "object",
"properties": {
"components_dir": {
"description": "The path where components are stored when adding or removing components",
"type": [
"string",
"null"
]
},
"registry": {
"description": "The component registry to default to when adding components",
"$ref": "#/$defs/ComponentRegistry"
}
}
},
"ComponentRegistry": {
"description": "Arguments for a component registry\nEither a path to a local directory or a remote git repo (with optional rev)",
"type": "object",
"properties": {
"git": {
"description": "The url of the component registry",
"type": [
"string",
"null"
]
},
"path": {
"description": "The path to the components directory",
"type": [
"string",
"null"
]
},
"rev": {
"description": "The revision of the component registry",
"type": [
"string",
"null"
]
}
}
},
"CustomSignCommandSettings": {
"type": "object",
"properties": {
"args": {
"description": "The arguments to pass to the command.\n\n\"%1\" will be replaced with the path to the binary to be signed.",
"type": "array",
"items": {
"type": "string"
}
},
"cmd": {
"description": "The command to run to sign the binary.",
"type": "string"
}
},
"required": [
"cmd",
"args"
]
},
"DebianSettings": {
"type": "object",
"properties": {
"changelog": {
"description": "Path of the uncompressed Changelog file, to be stored at /usr/share/doc/package-name/changelog.gz. See\n<https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes>",
"type": [
"string",
"null"
]
},
"conflicts": {
"description": "the list of package conflicts.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"depends": {
"description": "the list of debian dependencies.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"desktop_template": {
"description": "Path to a custom desktop file Handlebars template.\n\nAvailable variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
"type": [
"string",
"null"
]
},
"files": {
"description": "List of custom files to add to the deb package.\nMaps the path on the debian package to the path of the file to include (relative to the current working directory).",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"post_install_script": {
"description": "Path to script that will be executed after the package is unpacked. See\n<https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>",
"type": [
"string",
"null"
]
},
"post_remove_script": {
"description": "Path to script that will be executed after the package is removed. See\n<https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>",
"type": [
"string",
"null"
]
},
"pre_install_script": {
"description": "Path to script that will be executed before the package is unpacked. See\n<https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>",
"type": [
"string",
"null"
]
},
"pre_remove_script": {
"description": "Path to script that will be executed before the package is removed. See\n<https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html>",
"type": [
"string",
"null"
]
},
"priority": {
"description": "Change the priority of the Debian Package. By default, it is set to `optional`.\nRecognized Priorities as of now are : `required`, `important`, `standard`, `optional`, `extra`",
"type": [
"string",
"null"
]
},
"provides": {
"description": "the list of dependencies the package provides.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"recommends": {
"description": "the list of recommended debian dependencies.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"replaces": {
"description": "the list of package replaces.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"section": {
"description": "Define the section in Debian Control file. See : <https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections>",
"type": [
"string",
"null"
]
}
}
},
"DeepLinkConfig": {
"description": "Unified deep linking configuration.\n\nThis provides a cross-platform interface for URL schemes and universal/app links.\nPlatform-specific overrides can be configured in `[ios]` and `[android]` sections.\n\nExample:\n```toml\n[deep_links]\nschemes = [\"myapp\", \"com.example.myapp\"]\nhosts = [\"example.com\", \"*.example.com\"]\n```",
"type": "object",
"properties": {
"hosts": {
"description": "Universal link / App link hosts (e.g., \"example.com\").\nMaps to Associated Domains on iOS and App Links on Android.\nSupports wildcards like \"*.example.com\".",
"type": "array",
"items": {
"type": "string"
}
},
"paths": {
"description": "Path patterns for universal/app links (e.g., \"/app/*\", \"/share/*\").\nIf empty, all paths are matched.",
"type": "array",
"items": {
"type": "string"
}
},
"schemes": {
"description": "Custom URL schemes (e.g., \"myapp\" for myapp://path).\nMaps to CFBundleURLSchemes on iOS/macOS and intent-filter on Android.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"IosConfig": {
"description": "iOS-specific configuration.\n\nExample:\n```toml\n[ios]\ndeployment_target = \"15.0\"\nidentifier = \"com.example.myapp.ios\" # Override bundle.identifier for iOS\n\n[ios.entitlements]\napp-groups = [\"group.com.example.app\"]\n\n[ios.plist]\nUIBackgroundModes = [\"location\", \"fetch\"]\n```",
"type": "object",
"properties": {
"background_modes": {
"description": "Additional background modes beyond unified `[background]`.\nValid values: \"audio\", \"location\", \"voip\", \"fetch\", \"remote-notification\",\n\"newsstand-content\", \"external-accessory\", \"bluetooth-central\",\n\"bluetooth-peripheral\", \"processing\"",
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"description": "App category.\nOverrides `bundle.category` for iOS builds.",
"type": [
"string",
"null"
]
},
"copyright": {
"description": "Copyright notice.\nOverrides `bundle.copyright` for iOS builds.",
"type": [
"string",
"null"
]
},
"deployment_target": {
"description": "Minimum iOS deployment target (e.g., \"15.0\").",
"type": [
"string",
"null"
]
},
"document_types": {
"description": "Document types the app can open.",
"type": "array",
"items": {
"$ref": "#/$defs/IosDocumentType"
}
},
"entitlements": {
"description": "iOS entitlements configuration.",
"$ref": "#/$defs/IosEntitlements"
},
"exported_type_identifiers": {
"description": "Exported type identifiers (custom UTIs).",
"type": "array",
"items": {
"$ref": "#/$defs/IosTypeIdentifier"
}
},
"icon": {
"description": "Icons for the app.\nOverrides `bundle.icon` for iOS builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"identifier": {
"description": "The app's identifier (e.g., \"com.example.myapp\").\nOverrides `bundle.identifier` for iOS builds.",
"type": [
"string",
"null"
]
},
"imported_type_identifiers": {
"description": "Imported type identifiers.",
"type": "array",
"items": {
"$ref": "#/$defs/IosTypeIdentifier"
}
},
"info_plist": {
"description": "Path to custom Info.plist to merge with generated.",
"type": [
"string",
"null"
]
},
"long_description": {
"description": "Long description.\nOverrides `bundle.long_description` for iOS builds.",
"type": [
"string",
"null"
]
},
"plist": {
"description": "Additional Info.plist keys to merge.",
"type": "object",
"additionalProperties": true
},
"publisher": {
"description": "The app's publisher.\nOverrides `bundle.publisher` for iOS builds.",
"type": [
"string",
"null"
]
},
"raw": {
"description": "Raw XML injection points.",
"$ref": "#/$defs/IosRawConfig"
},
"resources": {
"description": "Additional resources to bundle.\nOverrides `bundle.resources` for iOS builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"short_description": {
"description": "Short description.\nOverrides `bundle.short_description` for iOS builds.",
"type": [
"string",
"null"
]
},
"url_schemes": {
"description": "Additional URL schemes beyond unified `[deep_links]`.schemes.\nThese are merged with the unified schemes.",
"type": "array",
"items": {
"type": "string"
}
},
"widget_extensions": {
"description": "Widget extensions to compile and bundle.\nEach entry defines a Swift-based widget extension (.appex) that will be\ncompiled and installed into the app's PlugIns folder.",
"type": "array",
"items": {
"$ref": "#/$defs/WidgetExtensionConfig"
}
}
}
},
"IosDocumentType": {
"description": "iOS document type declaration.",
"type": "object",
"properties": {
"extensions": {
"description": "File extensions (e.g., [\"txt\", \"md\"]).",
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"description": "Icon file name.",
"type": [
"string",
"null"
]
},
"mime_types": {
"description": "MIME types.",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "Document type name.",
"type": "string"
},
"role": {
"description": "Role: \"Editor\", \"Viewer\", \"Shell\", or \"None\".",
"type": [
"string",
"null"
]
},
"types": {
"description": "UTI types.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name"
]
},
"IosEntitlements": {
"type": "object",
"properties": {
"app-groups": {
"description": "App groups for shared data.",
"type": "array",
"items": {
"type": "string"
}
},
"apple-pay": {
"description": "Enable Apple Pay.",
"type": "boolean"
},
"aps-environment": {
"description": "Push notification environment: \"development\" or \"production\".",
"type": [
"string",
"null"
]
},
"associated-domains": {
"description": "Associated domains for universal links.",
"type": "array",
"items": {
"type": "string"
}
},
"healthkit": {
"description": "Enable HealthKit.",
"type": "boolean"
},
"homekit": {
"description": "Enable HomeKit.",
"type": "boolean"
},
"icloud": {
"description": "Enable iCloud container support.",
"type": "boolean"
},
"keychain-access-groups": {
"description": "Keychain access groups.",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"IosRawConfig": {
"type": "object",
"properties": {
"entitlements": {
"description": "Raw XML to inject into entitlements.plist.",
"type": [
"string",
"null"
]
},
"info_plist": {
"description": "Raw XML to inject into Info.plist.",
"type": [
"string",
"null"
]
}
}
},
"IosTypeIdentifier": {
"description": "iOS Uniform Type Identifier declaration.",
"type": "object",
"properties": {
"conforms_to": {
"description": "Conforms to these UTIs.",
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"description": "Human-readable description.",
"type": [
"string",
"null"
]
},
"extensions": {
"description": "File extensions.",
"type": "array",
"items": {
"type": "string"
}
},
"identifier": {
"description": "UTI identifier (e.g., \"com.example.myformat\").",
"type": "string"
},
"mime_types": {
"description": "MIME types.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"identifier"
]
},
"LinuxConfig": {
"description": "Linux-specific configuration.\n\nExample:\n```toml\n[linux]\nidentifier = \"com.example.myapp.linux\" # Override bundle.identifier for Linux\ncategories = [\"Utility\"]\n\n# Debian package settings (previously in [bundle.deb])\n[linux.deb]\ndepends = [\"libwebkit2gtk-4.0-37\"]\nsection = \"utils\"\n```",
"type": "object",
"properties": {
"categories": {
"description": "Desktop entry categories.",
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"description": "App category.\nOverrides `bundle.category` for Linux builds.",
"type": [
"string",
"null"
]
},
"copyright": {
"description": "Copyright notice.\nOverrides `bundle.copyright` for Linux builds.",
"type": [
"string",
"null"
]
},
"dbus_access": {
"description": "D-Bus interfaces to access.",
"type": "array",
"items": {
"type": "string"
}
},
"deb": {
"description": "Debian-specific package settings.",
"anyOf": [
{
"$ref": "#/$defs/LinuxDebSettings"
},
{
"type": "null"
}
]
},
"flatpak_permissions": {
"description": "Flatpak sandbox permissions.",
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"description": "Icons for the app.\nOverrides `bundle.icon` for Linux builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"identifier": {
"description": "The app's identifier (e.g., \"com.example.myapp\").\nOverrides `bundle.identifier` for Linux builds.",
"type": [
"string",
"null"
]
},
"keywords": {
"description": "Desktop entry keywords.",
"type": "array",
"items": {
"type": "string"
}
},
"long_description": {
"description": "Long description.\nOverrides `bundle.long_description` for Linux builds.",
"type": [
"string",
"null"
]
},
"mime_types": {
"description": "MIME types the app can handle.",
"type": "array",
"items": {
"type": "string"
}
},
"publisher": {
"description": "The app's publisher.\nOverrides `bundle.publisher` for Linux builds.",
"type": [
"string",
"null"
]
},
"resources": {
"description": "Additional resources to bundle.\nOverrides `bundle.resources` for Linux builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"short_description": {
"description": "Short description.\nOverrides `bundle.short_description` for Linux builds.",
"type": [
"string",
"null"
]
}
}
},
"LinuxDebSettings": {
"description": "Debian package settings.",
"type": "object",
"properties": {
"changelog": {
"description": "Path to changelog file.",
"type": [
"string",
"null"
]
},
"conflicts": {
"description": "Package conflicts.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"depends": {
"description": "Package dependencies.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"desktop_template": {
"description": "Path to custom desktop template.",
"type": [
"string",
"null"
]
},
"files": {
"description": "Additional files to include. Maps package path to source path.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"post_install_script": {
"description": "Post-install script path.",
"type": [
"string",
"null"
]
},
"post_remove_script": {
"description": "Post-remove script path.",
"type": [
"string",
"null"
]
},
"pre_install_script": {
"description": "Pre-install script path.",
"type": [
"string",
"null"
]
},
"pre_remove_script": {
"description": "Pre-remove script path.",
"type": [
"string",
"null"
]
},
"priority": {
"description": "Package priority (\"required\", \"important\", \"standard\", \"optional\", \"extra\").",
"type": [
"string",
"null"
]
},
"provides": {
"description": "Packages this provides.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"recommends": {
"description": "Recommended packages.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"replaces": {
"description": "Packages this replaces.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"section": {
"description": "Debian section (e.g., \"utils\", \"web\").",
"type": [
"string",
"null"
]
}
}
},
"LocationPermission": {
"description": "Location permission with precision control.",
"type": "object",
"properties": {
"description": {
"description": "User-facing description shown in permission dialogs.",
"type": "string"
},
"precision": {
"description": "Precision level: \"fine\" (GPS) or \"coarse\" (network-based).",
"$ref": "#/$defs/LocationPrecision"
}
},
"required": [
"description"
]
},
"LocationPrecision": {
"type": "string",
"enum": [
"fine",
"coarse"
]
},
"MacOsSettings": {
"type": "object",
"properties": {
"bundle_name": {
"type": [
"string",
"null"
]
},
"bundle_version": {
"type": [
"string",
"null"
]
},
"entitlements": {
"type": [
"string",
"null"
]
},
"exception_domain": {
"type": [
"string",
"null"
]
},
"files": {
"description": "List of custom files to add to the application bundle.\nMaps the path in the Contents directory in the app to the path of the file to include (relative to the current working directory).",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"frameworks": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"hardened_runtime": {
"description": "Preserve the hardened runtime version flag, see <https://developer.apple.com/documentation/security/hardened_runtime>\n\nSettings this to `false` is useful when using an ad-hoc signature, making it less strict.",
"type": "boolean"
},
"info_plist_path": {
"type": [
"string",
"null"
]
},
"license": {
"type": [
"string",
"null"
]
},
"minimum_system_version": {
"type": [
"string",
"null"
]
},
"provider_short_name": {
"type": [
"string",
"null"
]
},
"signing_identity": {
"type": [
"string",
"null"
]
}
}
},
"MacosConfig": {
"description": "macOS-specific configuration.\n\nExample:\n```toml\n[macos]\nminimum_system_version = \"11.0\"\nidentifier = \"com.example.myapp.macos\" # Override bundle.identifier for macOS\n\n# macOS signing (previously in [bundle.macos])\nsigning_identity = \"Developer ID Application: My Company\"\nprovider_short_name = \"MYCOMPANY\"\n```",
"type": "object",
"properties": {
"bundle_name": {
"description": "The bundle short version string (CFBundleShortVersionString).",
"type": [
"string",
"null"
]
},
"bundle_version": {
"description": "The bundle version string (CFBundleVersion).",
"type": [
"string",
"null"
]
},
"category": {
"description": "App category for the Mac App Store.\nE.g., \"public.app-category.productivity\"",
"type": [
"string",
"null"
]
},
"copyright": {
"description": "Copyright notice.\nOverrides `bundle.copyright` for macOS builds.",
"type": [
"string",
"null"
]
},
"document_types": {
"description": "Document types the app can open (uses same format as iOS).",
"type": "array",
"items": {
"$ref": "#/$defs/IosDocumentType"
}
},
"entitlements": {
"description": "macOS entitlements.",
"$ref": "#/$defs/MacosEntitlements"
},
"entitlements_file": {
"description": "Path to custom entitlements file for code signing.\nThis overrides the generated entitlements.",
"type": [
"string",
"null"
]
},
"exception_domain": {
"description": "Exception domain for App Transport Security.",
"type": [
"string",
"null"
]
},
"exported_type_identifiers": {
"description": "Exported type identifiers (custom UTIs).",
"type": "array",
"items": {
"$ref": "#/$defs/IosTypeIdentifier"
}
},
"files": {
"description": "Additional files to include in the app bundle.\nMaps the path in the Contents directory to the source file path.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"frameworks": {
"description": "Frameworks to embed.",
"type": "array",
"items": {
"type": "string"
}
},
"hardened_runtime": {
"description": "Preserve the hardened runtime version flag.\nSetting this to false is useful when using an ad-hoc signature.",
"type": [
"boolean",
"null"
]
},
"icon": {
"description": "Icons for the app.\nOverrides `bundle.icon` for macOS builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"identifier": {
"description": "The app's identifier (e.g., \"com.example.myapp\").\nOverrides `bundle.identifier` for macOS builds.",
"type": [
"string",
"null"
]
},
"imported_type_identifiers": {
"description": "Imported type identifiers.",
"type": "array",
"items": {
"$ref": "#/$defs/IosTypeIdentifier"
}
},
"info_plist": {
"description": "Path to custom Info.plist.",
"type": [
"string",
"null"
]
},
"license": {
"description": "License file to include in DMG.",
"type": [
"string",
"null"
]
},
"long_description": {
"description": "Long description.\nOverrides `bundle.long_description` for macOS builds.",
"type": [
"string",
"null"
]
},
"minimum_system_version": {
"description": "Minimum macOS version (e.g., \"11.0\").",
"type": [
"string",
"null"
]
},
"plist": {
"description": "Additional Info.plist keys.",
"type": "object",
"additionalProperties": true
},
"provider_short_name": {
"description": "The provider short name for notarization.",
"type": [
"string",
"null"
]
},
"publisher": {
"description": "The app's publisher.\nOverrides `bundle.publisher` for macOS builds.",
"type": [
"string",
"null"
]
},
"raw": {
"description": "Raw injection points.",
"$ref": "#/$defs/MacosRawConfig"
},
"resources": {
"description": "Additional resources to bundle.\nOverrides `bundle.resources` for macOS builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"short_description": {
"description": "Short description.\nOverrides `bundle.short_description` for macOS builds.",
"type": [
"string",
"null"
]
},
"signing_identity": {
"description": "The signing identity to use for code signing.\nE.g., \"Developer ID Application: My Company (TEAMID)\"",
"type": [
"string",
"null"
]
},
"url_schemes": {
"description": "Additional URL schemes beyond unified `[deep_links]`.schemes.\nThese are merged with the unified schemes.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MacosEntitlements": {
"type": "object",
"properties": {
"addressbook": {
"description": "Address book access.",
"type": [
"boolean",
"null"
]
},
"allow-jit": {
"description": "Allow JIT.",
"type": [
"boolean",
"null"
]
},
"allow-unsigned-executable-memory": {
"description": "Allow unsigned executable memory.",
"type": [
"boolean",
"null"
]
},
"app-sandbox": {
"description": "Enable App Sandbox.",
"type": [
"boolean",
"null"
]
},
"bluetooth": {
"description": "Bluetooth access.",
"type": [
"boolean",
"null"
]
},
"calendars": {
"description": "Calendars access.",
"type": [
"boolean",
"null"
]
},
"camera": {
"description": "Camera access.",
"type": [
"boolean",
"null"
]
},
"disable-library-validation": {
"description": "Disable library validation.",
"type": [
"boolean",
"null"
]
},
"files-user-selected": {
"description": "User-selected file access (read-write).",
"type": [
"boolean",
"null"
]
},
"files-user-selected-readonly": {
"description": "User-selected file access (read-only).",
"type": [
"boolean",
"null"
]
},
"location": {
"description": "Location services.",
"type": [
"boolean",
"null"
]
},
"microphone": {
"description": "Microphone access.",
"type": [
"boolean",
"null"
]
},
"network-client": {
"description": "Outgoing network connections.",
"type": [
"boolean",
"null"
]
},
"network-server": {
"description": "Incoming network connections.",
"type": [
"boolean",
"null"
]
},
"print": {
"description": "Printing.",
"type": [
"boolean",
"null"
]
},
"usb": {
"description": "USB access.",
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": true
},
"MacosRawConfig": {
"type": "object",
"properties": {
"entitlements": {
"description": "Raw XML to inject into entitlements.plist.",
"type": [
"string",
"null"
]
},
"info_plist": {
"description": "Raw XML to inject into Info.plist.",
"type": [
"string",
"null"
]
}
}
},
"NSISInstallerMode": {
"type": "string",
"enum": [
"CurrentUser",
"PerMachine",
"Both"
]
},
"NsisSettings": {
"type": "object",
"properties": {
"custom_language_files": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"display_language_selector": {
"type": "boolean"
},
"header_image": {
"type": [
"string",
"null"
]
},
"install_mode": {
"$ref": "#/$defs/NSISInstallerMode"
},
"installer_hooks": {
"type": [
"string",
"null"
]
},
"installer_icon": {
"type": [
"string",
"null"
]
},
"languages": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"license": {
"type": [
"string",
"null"
]
},
"minimum_webview2_version": {
"description": "Try to ensure that the WebView2 version is equal to or newer than this version,\nif the user's WebView2 is older than this version,\nthe installer will try to trigger a WebView2 update.",
"type": [
"string",
"null"
]
},
"sidebar_image": {
"type": [
"string",
"null"
]
},
"start_menu_folder": {
"type": [
"string",
"null"
]
},
"template": {
"type": [
"string",
"null"
]
}
}
},
"PermissionsConfig": {
"description": "Unified permission configuration that maps to platform-specific identifiers.\n\nExample:\n```toml\n[permissions]\nlocation = { precision = \"fine\", description = \"Track your runs\" }\ncamera = { description = \"Take photos for your profile\" }\n```",
"type": "object",
"properties": {
"background-location": {
"description": "Background location updates.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"biometrics": {
"description": "Biometric authentication (Face ID, fingerprint).",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"bluetooth": {
"description": "Bluetooth connectivity.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"calendar": {
"description": "Calendar access.",
"anyOf": [
{
"$ref": "#/$defs/StoragePermission"
},
{
"type": "null"
}
]
},
"camera": {
"description": "Camera access permission.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"contacts": {
"description": "Contacts access.",
"anyOf": [
{
"$ref": "#/$defs/StoragePermission"
},
{
"type": "null"
}
]
},
"health": {
"description": "Health data access.",
"anyOf": [
{
"$ref": "#/$defs/StoragePermission"
},
{
"type": "null"
}
]
},
"homekit": {
"description": "HomeKit integration (iOS only).",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"local-network": {
"description": "Local network access.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"location": {
"description": "Location permission with precision level.\nMaps to ACCESS_FINE_LOCATION/ACCESS_COARSE_LOCATION on Android,\nNSLocationWhenInUseUsageDescription on iOS/macOS.",
"anyOf": [
{
"$ref": "#/$defs/LocationPermission"
},
{
"type": "null"
}
]
},
"media-library": {
"description": "Media library access.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"microphone": {
"description": "Microphone access permission.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"motion": {
"description": "Motion and fitness data.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"nearby-wifi": {
"description": "Nearby Wi-Fi devices (Android).",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"nfc": {
"description": "NFC access.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"notifications": {
"description": "Push notifications permission.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"photos": {
"description": "Photo library access.",
"anyOf": [
{
"$ref": "#/$defs/StoragePermission"
},
{
"type": "null"
}
]
},
"siri": {
"description": "Siri integration (iOS only).",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
},
"speech": {
"description": "Speech recognition.",
"anyOf": [
{
"$ref": "#/$defs/SimplePermission"
},
{
"type": "null"
}
]
}
}
},
"RawPermission": {
"description": "Raw platform permission entry.",
"type": "object",
"properties": {
"description": {
"type": "string"
}
},
"required": [
"description"
]
},
"SimplePermission": {
"description": "Simple permission with just a description.",
"type": "object",
"properties": {
"description": {
"description": "User-facing description shown in permission dialogs.",
"type": "string"
}
},
"required": [
"description"
]
},
"StorageAccess": {
"type": "string",
"enum": [
"read",
"write",
"read-write"
]
},
"StoragePermission": {
"description": "Storage permission with access level control.",
"type": "object",
"properties": {
"access": {
"description": "Access level: \"read\", \"write\", or \"read-write\".",
"$ref": "#/$defs/StorageAccess"
},
"description": {
"description": "User-facing description shown in permission dialogs.",
"type": "string"
}
},
"required": [
"description"
]
},
"WasmOptConfig": {
"description": "The wasm-opt configuration",
"type": "object",
"properties": {
"debug": {
"description": "Keep debug symbols in the wasm file",
"type": "boolean"
},
"extra_features": {
"description": "Extra arguments to pass to wasm-opt\n\nFor example, to enable simd, you can set this to `[\"--enable-simd\"]`.\n\nYou can also disable features by prefixing them with `--disable-`, e.g. `[\"--disable-bulk-memory\"]`.\n\nCurrently only --enable and --disable flags are supported.",
"type": "array",
"items": {
"type": "string"
}
},
"keep_names": {
"description": "Keep the wasm name section, useful for profiling and debugging\n\nUnlike `debug` which preserves DWARF debug symbols (requiring a browser extension to read),\nthe name section allows tools like `console_error_panic_hook` to print backtraces with\nhuman-readable function names without any browser extension.",
"type": "boolean"
},
"level": {
"description": "The wasm-opt level to use for release builds [default: s]\nOptions:\n- z: optimize aggressively for size\n- s: optimize for size\n- 1: optimize for speed\n- 2: optimize for more for speed\n- 3: optimize for even more for speed\n- 4: optimize aggressively for speed",
"$ref": "#/$defs/WasmOptLevel"
},
"memory_packing": {
"description": "Enable memory packing",
"type": "boolean"
}
}
},
"WasmOptLevel": {
"description": "The wasm-opt level to use for release web builds [default: Z]",
"oneOf": [
{
"description": "Optimize aggressively for size",
"type": "string",
"const": "z"
},
{
"description": "Optimize for size",
"type": "string",
"const": "s"
},
{
"description": "Don't optimize",
"type": "string",
"const": "0"
},
{
"description": "Optimize for speed",
"type": "string",
"const": "1"
},
{
"description": "Optimize for more for speed",
"type": "string",
"const": "2"
},
{
"description": "Optimize for even more for speed",
"type": "string",
"const": "3"
},
{
"description": "Optimize aggressively for speed",
"type": "string",
"const": "4"
}
]
},
"WebAppConfig": {
"type": "object",
"properties": {
"base_path": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
}
}
},
"WebConfig": {
"type": "object",
"properties": {
"app": {
"$ref": "#/$defs/WebAppConfig"
},
"https": {
"$ref": "#/$defs/WebHttpsConfig"
},
"pre_compress": {
"description": "Whether to enable pre-compression of assets and wasm during a web build in release mode",
"type": "boolean"
},
"proxy": {
"type": "array",
"items": {
"$ref": "#/$defs/WebProxyConfig"
}
},
"resource": {
"$ref": "#/$defs/WebResourceConfig"
},
"wasm_opt": {
"description": "The wasm-opt configuration",
"$ref": "#/$defs/WasmOptConfig"
},
"watcher": {
"$ref": "#/$defs/WebWatcherConfig"
}
}
},
"WebDevResourceConfig": {
"type": "object",
"properties": {
"script": {
"type": "array",
"items": {
"type": "string"
}
},
"style": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"WebHttpsConfig": {
"type": "object",
"properties": {
"cert_path": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
},
"key_path": {
"type": [
"string",
"null"
]
},
"mkcert": {
"type": [
"boolean",
"null"
]
}
}
},
"WebProxyConfig": {
"type": "object",
"properties": {
"backend": {
"type": "string"
}
},
"required": [
"backend"
]
},
"WebResourceConfig": {
"type": "object",
"properties": {
"dev": {
"$ref": "#/$defs/WebDevResourceConfig"
},
"script": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"style": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
},
"required": [
"dev"
]
},
"WebWatcherConfig": {
"type": "object",
"properties": {
"index_on_404": {
"type": "boolean"
},
"reload_html": {
"type": "boolean"
},
"watch_path": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"WebviewInstallMode": {
"oneOf": [
{
"type": "string",
"enum": [
"Skip"
]
},
{
"type": "object",
"properties": {
"DownloadBootstrapper": {
"type": "object",
"properties": {
"silent": {
"type": "boolean"
}
},
"required": [
"silent"
]
}
},
"additionalProperties": false,
"required": [
"DownloadBootstrapper"
]
},
{
"type": "object",
"properties": {
"EmbedBootstrapper": {
"type": "object",
"properties": {
"silent": {
"type": "boolean"
}
},
"required": [
"silent"
]
}
},
"additionalProperties": false,
"required": [
"EmbedBootstrapper"
]
},
{
"type": "object",
"properties": {
"OfflineInstaller": {
"type": "object",
"properties": {
"silent": {
"type": "boolean"
}
},
"required": [
"silent"
]
}
},
"additionalProperties": false,
"required": [
"OfflineInstaller"
]
},
{
"type": "object",
"properties": {
"FixedRuntime": {
"type": "object",
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
]
}
},
"additionalProperties": false,
"required": [
"FixedRuntime"
]
}
]
},
"WidgetExtensionConfig": {
"description": "Configuration for an iOS Widget Extension.\n\nWidget extensions are compiled as Swift executables and bundled as .appex\nbundles in the app's PlugIns folder.\n\nExample in Dioxus.toml:\n```toml\n[[ios.widget_extensions]]\nsource = \"src/ios/widget\"\ndisplay_name = \"Location Widget\"\nbundle_id_suffix = \"location-widget\"\ndeployment_target = \"16.2\"\nmodule_name = \"GeolocationPlugin\"\n```",
"type": "object",
"properties": {
"bundle_id_suffix": {
"description": "Bundle ID suffix appended to the app's bundle identifier.\nFor example, if the app is \"com.example.app\" and suffix is \"location-widget\",\nthe widget bundle ID will be \"com.example.app.location-widget\".",
"type": "string"
},
"deployment_target": {
"description": "Minimum deployment target (e.g., \"16.2\").\nDefaults to the app's iOS deployment target if not specified.",
"type": [
"string",
"null"
]
},
"display_name": {
"description": "Display name for the widget (shown in system UI).",
"type": "string"
},
"module_name": {
"description": "Swift module name for the widget.\nThis MUST match the module name used by the main app's Swift plugin\nfor ActivityKit type matching to work.",
"type": "string"
},
"source": {
"description": "Path to the Swift package source directory (relative to project root).",
"type": "string"
}
},
"required": [
"source",
"display_name",
"bundle_id_suffix",
"module_name"
]
},
"WindowsConfig": {
"description": "Windows-specific configuration.\n\nExample:\n```toml\n[windows]\nidentifier = \"com.example.myapp.windows\" # Override bundle.identifier for Windows\n\n# Windows installer settings (previously in [bundle.windows])\n[windows.nsis]\ninstall_mode = \"PerMachine\"\n\n[windows.wix]\nlanguage = [[\"en-US\", null]]\n```",
"type": "object",
"properties": {
"allow_downgrades": {
"description": "Allow downgrades when installing.",
"type": [
"boolean",
"null"
]
},
"capabilities": {
"description": "UWP/MSIX capabilities.",
"type": "array",
"items": {
"type": "string"
}
},
"category": {
"description": "App category.\nOverrides `bundle.category` for Windows builds.",
"type": [
"string",
"null"
]
},
"certificate_thumbprint": {
"description": "Certificate thumbprint for code signing.",
"type": [
"string",
"null"
]
},
"copyright": {
"description": "Copyright notice.\nOverrides `bundle.copyright` for Windows builds.",
"type": [
"string",
"null"
]
},
"device_capabilities": {
"description": "Device capabilities.",
"type": "array",
"items": {
"type": "string"
}
},
"digest_algorithm": {
"description": "Digest algorithm for code signing.",
"type": [
"string",
"null"
]
},
"icon": {
"description": "Icons for the app.\nOverrides `bundle.icon` for Windows builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"icon_path": {
"description": "Path to custom Windows icon.",
"type": [
"string",
"null"
]
},
"identifier": {
"description": "The app's identifier (e.g., \"com.example.myapp\").\nOverrides `bundle.identifier` for Windows builds.",
"type": [
"string",
"null"
]
},
"long_description": {
"description": "Long description.\nOverrides `bundle.long_description` for Windows builds.",
"type": [
"string",
"null"
]
},
"nsis": {
"description": "NSIS installer settings.",
"anyOf": [
{
"$ref": "#/$defs/WindowsNsisSettings"
},
{
"type": "null"
}
]
},
"publisher": {
"description": "The app's publisher.\nOverrides `bundle.publisher` for Windows builds.",
"type": [
"string",
"null"
]
},
"resources": {
"description": "Additional resources to bundle.\nOverrides `bundle.resources` for Windows builds.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"restricted_capabilities": {
"description": "Restricted capabilities.",
"type": "array",
"items": {
"type": "string"
}
},
"short_description": {
"description": "Short description.\nOverrides `bundle.short_description` for Windows builds.",
"type": [
"string",
"null"
]
},
"sign_command": {
"description": "Custom sign command.",
"anyOf": [
{
"$ref": "#/$defs/WindowsSignCommand"
},
{
"type": "null"
}
]
},
"timestamp_url": {
"description": "Timestamp server URL for code signing.",
"type": [
"string",
"null"
]
},
"tsp": {
"description": "Use TSP (RFC 3161) timestamp.",
"type": [
"boolean",
"null"
]
},
"webview_install_mode": {
"description": "WebView2 installation mode.",
"anyOf": [
{
"$ref": "#/$defs/WindowsWebviewInstallMode"
},
{
"type": "null"
}
]
},
"wix": {
"description": "WiX installer settings.",
"anyOf": [
{
"$ref": "#/$defs/WindowsWixSettings"
},
{
"type": "null"
}
]
}
}
},
"WindowsNsisSettings": {
"description": "NSIS installer settings.",
"type": "object",
"properties": {
"custom_language_files": {
"description": "Custom language files.",
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
}
},
"display_language_selector": {
"description": "Display language selector.",
"type": [
"boolean",
"null"
]
},
"header_image": {
"description": "Header image path.",
"type": [
"string",
"null"
]
},
"install_mode": {
"description": "Installation mode: \"CurrentUser\", \"PerMachine\", or \"Both\".",
"type": [
"string",
"null"
]
},
"installer_hooks": {
"description": "Installer hooks script path.",
"type": [
"string",
"null"
]
},
"installer_icon": {
"description": "Installer icon path.",
"type": [
"string",
"null"
]
},
"languages": {
"description": "Languages to include.",
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"license": {
"description": "License file path.",
"type": [
"string",
"null"
]
},
"minimum_webview2_version": {
"description": "Minimum WebView2 version required.",
"type": [
"string",
"null"
]
},
"sidebar_image": {
"description": "Sidebar image path.",
"type": [
"string",
"null"
]
},
"start_menu_folder": {
"description": "Start menu folder name.",
"type": [
"string",
"null"
]
},
"template": {
"description": "Path to custom NSIS template.",
"type": [
"string",
"null"
]
}
}
},
"WindowsSettings": {
"type": "object",
"properties": {
"add_toolkit_include": {
"description": "Pass the host Windows SDK's `um/` and `shared/` headers to `rc.exe` via\n`/I` flags. Only relevant when cross-compiling to MSVC from a\nnon-Windows host where the SDK headers aren't on the default include\npath. Has no effect for the GNU (`windres`) toolchain.",
"type": [
"boolean",
"null"
]
},
"allow_downgrades": {
"type": "boolean"
},
"certificate_thumbprint": {
"type": [
"string",
"null"
]
},
"comments": {
"description": "Free-form developer comments embedded in the executable's VERSIONINFO,\nsurfaced in Windows Explorer → Properties → Details → Comments.",
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"type": [
"string",
"null"
]
},
"extra_rc": {
"description": "Raw `.rc` snippet appended verbatim to the generated resource file.\nUse this to add custom resources not covered by other settings —\napplication manifests, custom string tables, accelerators, etc.\nContents are not escaped.",
"type": [
"string",
"null"
]
},
"icon_path": {
"type": [
"string",
"null"
]
},
"internal_name": {
"description": "Internal name embedded in the executable's VERSIONINFO. Most apps leave\nthis equal to the product name; override only if the binary is known\ninternally by a different identifier (e.g. an original codename).",
"type": [
"string",
"null"
]
},
"language": {
"description": "VERSIONINFO LANGID for the resource block. Hex form like `0x0409`\n(en-US) or `0x0407` (de-DE). Defaults to `0x0000` (neutral). See\n<https://learn.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource#langID>\nfor the full table.",
"type": [
"integer",
"null"
],
"format": "uint16",
"maximum": 65535,
"minimum": 0
},
"nsis": {
"anyOf": [
{
"$ref": "#/$defs/NsisSettings"
},
{
"type": "null"
}
]
},
"sign_command": {
"description": "Specify a custom command to sign the binaries.\nThis command needs to have a `%1` in it which is just a placeholder for the binary path,\nwhich we will detect and replace before calling the command.\n\nExample:\n```text\nsign-cli --arg1 --arg2 %1\n```\n\nBy Default we use `signtool.exe` which can be found only on Windows so\nif you are on another platform and want to cross-compile and sign you will\nneed to use another tool like `osslsigncode`.",
"anyOf": [
{
"$ref": "#/$defs/CustomSignCommandSettings"
},
{
"type": "null"
}
]
},
"timestamp_url": {
"type": [
"string",
"null"
]
},
"tsp": {
"type": "boolean"
},
"webview_fixed_runtime_path": {
"type": [
"string",
"null"
]
},
"webview_install_mode": {
"$ref": "#/$defs/WebviewInstallMode"
},
"wix": {
"anyOf": [
{
"$ref": "#/$defs/WixSettings"
},
{
"type": "null"
}
]
}
}
},
"WindowsSignCommand": {
"description": "Custom sign command for Windows code signing.",
"type": "object",
"properties": {
"args": {
"description": "Command arguments. Use \"%1\" as placeholder for binary path.",
"type": "array",
"items": {
"type": "string"
}
},
"cmd": {
"description": "The command to run.",
"type": "string"
}
},
"required": [
"cmd",
"args"
]
},
"WindowsWebviewInstallMode": {
"description": "WebView2 installation mode.",
"oneOf": [
{
"description": "Skip WebView2 installation.",
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "Skip"
}
},
"required": [
"type"
]
},
{
"description": "Download bootstrapper.",
"type": "object",
"properties": {
"silent": {
"type": "boolean"
},
"type": {
"type": "string",
"const": "DownloadBootstrapper"
}
},
"required": [
"type"
]
},
{
"description": "Embed bootstrapper.",
"type": "object",
"properties": {
"silent": {
"type": "boolean"
},
"type": {
"type": "string",
"const": "EmbedBootstrapper"
}
},
"required": [
"type"
]
},
{
"description": "Use offline installer.",
"type": "object",
"properties": {
"silent": {
"type": "boolean"
},
"type": {
"type": "string",
"const": "OfflineInstaller"
}
},
"required": [
"type"
]
},
{
"description": "Use fixed runtime from path.",
"type": "object",
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string",
"const": "FixedRuntime"
}
},
"required": [
"type",
"path"
]
}
]
},
"WindowsWixSettings": {
"description": "WiX installer settings.",
"type": "object",
"properties": {
"banner_path": {
"description": "Banner image path.",
"type": [
"string",
"null"
]
},
"component_group_refs": {
"description": "Component group references.",
"type": "array",
"items": {
"type": "string"
}
},
"component_refs": {
"description": "Component references.",
"type": "array",
"items": {
"type": "string"
}
},
"dialog_image_path": {
"description": "Dialog image path.",
"type": [
"string",
"null"
]
},
"enable_elevated_update_task": {
"description": "Enable elevated update task.",
"type": [
"boolean",
"null"
]
},
"feature_group_refs": {
"description": "Feature group references.",
"type": "array",
"items": {
"type": "string"
}
},
"feature_refs": {
"description": "Feature references.",
"type": "array",
"items": {
"type": "string"
}
},
"fips_compliant": {
"description": "FIPS compliant mode.",
"type": [
"boolean",
"null"
]
},
"fragment_paths": {
"description": "WiX fragment files to include.",
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"description": "Languages and their locale paths.",
"type": "array",
"items": {
"type": "array",
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "string"
},
{
"type": [
"string",
"null"
]
}
]
}
},
"license": {
"description": "License file path.",
"type": [
"string",
"null"
]
},
"merge_refs": {
"description": "Merge module references.",
"type": "array",
"items": {
"type": "string"
}
},
"skip_webview_install": {
"description": "Skip WebView2 installation.",
"type": [
"boolean",
"null"
]
},
"template": {
"description": "Path to custom WiX template.",
"type": [
"string",
"null"
]
},
"upgrade_code": {
"description": "MSI upgrade code (GUID).",
"type": [
"string",
"null"
]
},
"version": {
"description": "MSI version string.",
"type": [
"string",
"null"
]
}
}
},
"WixSettings": {
"type": "object",
"properties": {
"banner_path": {
"type": [
"string",
"null"
]
},
"component_group_refs": {
"type": "array",
"items": {
"type": "string"
}
},
"component_refs": {
"type": "array",
"items": {
"type": "string"
}
},
"dialog_image_path": {
"type": [
"string",
"null"
]
},
"enable_elevated_update_task": {
"type": "boolean"
},
"feature_group_refs": {
"type": "array",
"items": {
"type": "string"
}
},
"feature_refs": {
"type": "array",
"items": {
"type": "string"
}
},
"fips_compliant": {
"type": "boolean"
},
"fragment_paths": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": "array",
"items": {
"type": "array",
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "string"
},
{
"type": [
"string",
"null"
]
}
]
}
},
"license": {
"type": [
"string",
"null"
]
},
"merge_refs": {
"type": "array",
"items": {
"type": "string"
}
},
"skip_webview_install": {
"type": "boolean"
},
"template": {
"type": [
"string",
"null"
]
},
"upgrade_code": {
"description": "A GUID upgrade code for MSI installer. This code **_must stay the same across all of your updates_**,\notherwise, Windows will treat your update as a different app and your users will have duplicate versions of your app.\n\nBy default, this code is generated as a Uuid v5 using the string `<productName>.exe.app.x64` in the DNS namespace.\n\nIt is recommended that you set this value in your Dioxus.toml to avoid accidental changes in your upgrade code\nwhenever you want to change your product name.",
"type": [
"string",
"null"
]
},
"version": {
"description": "MSI installer version in the format `major.minor.patch.build` (build is optional).\n\nBecause a valid version is required for MSI installer, it will be derived from the package version if this field is not set.\n\nThe first field is the major version and has a maximum value of 255. The second field is the minor version and has a maximum value of 255.\nThe third and fourth fields have a maximum value of 65,535.\n\nSee <https://learn.microsoft.com/en-us/windows/win32/msi/productversion> for more info.",
"type": [
"string",
"null"
]
}
}
}
}
}