Skip to main content

Interface: AppXOptions

Extends​

Properties​

addAutoLaunchExtension?​

readonly optional addAutoLaunchExtension?: boolean

Whether to add auto launch extension. Defaults to true if electron-winstore-auto-launch in the dependencies.

applicationId?​

readonly optional applicationId?: string

The application id. Defaults to identityName. This string contains alpha-numeric fields separated by periods. Each field must begin with an ASCII alphabetic character.

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

TargetSpecificOptions.artifactName

backgroundColor?​

readonly optional backgroundColor?: string | null

The background color of the app tile. See Visual Elements.

Default​

#464646

capabilities?​

readonly optional capabilities?: string[] | null

The list of capabilities to be added to an appmanifest.xml. The runFullTrust capability is obligatory for electron apps and will be auto added if not specified here. Defaults to ['runFullTrust'] if omitted Example: ['runFullTrust', 'privateNetworkClientServer', 'webcam']

customExtensionsPath?​

readonly optional customExtensionsPath?: string

Relative path to custom extensions xml to be included in an appmanifest.xml.

customManifestPath?​

readonly optional customManifestPath?: string

(Advanced Option) Relative path to custom appmanifest.xml (file name doesn't matter, it'll be renamed) located in build resources directory. Supports the following template macros:

  • ${publisher}
  • ${publisherDisplayName}
  • ${version}
  • ${applicationId}
  • ${identityName}
  • ${executable}
  • ${displayName}
  • ${description}
  • ${backgroundColor}
  • ${logo}
  • ${square150x150Logo}
  • ${square44x44Logo}
  • ${lockScreen}
  • ${defaultTile}
  • ${splashScreen}
  • ${arch}
  • ${resourceLanguages}
  • ${capabilities}
  • ${extensions}
  • ${minVersion}
  • ${maxVersionTested}

displayName?​

readonly optional displayName?: string | null

A friendly name that can be displayed to users. Corresponds to Properties.DisplayName. Defaults to the application product name.

identityName?​

readonly optional identityName?: string | null

The name. Corresponds to Identity.Name. Defaults to the application name.

languages?​

readonly optional languages?: string | string[] | null

The list of supported languages that will be listed in the Windows Store. The first entry (index 0) will be the default language. Defaults to en-US if omitted.

maxVersionTested?​

readonly optional maxVersionTested?: string | null

Set the MaxVersionTested field in the appx manifest.xml

Default​

arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"

minVersion?​

readonly optional minVersion?: string | null

Set the MinVersion field in the appx manifest.xml

Default​

arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

publisher?​

readonly optional publisher?: string | null

The Windows Store publisher. Not used if AppX is build for testing. See AppX Package Code Signing below.

publisherDisplayName?​

readonly optional publisherDisplayName?: string | null

A friendly name for the publisher that can be displayed to users. Corresponds to Properties.PublisherDisplayName. Defaults to company name from the application metadata.

setBuildNumber?​

readonly optional setBuildNumber?: boolean

Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875

Default​

false

showNameOnTiles?​

readonly optional showNameOnTiles?: boolean

Whether to overlay the app's name on top of tile images on the Start screen. Defaults to false. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.

Default​

false