Skip to main content

Interface: DmgOptions

Extends​

Properties​

artifactName?​

readonly optional artifactName?: string | null

The artifact file name template.

Inherited from​

TargetSpecificOptions.artifactName

background?​

optional background?: string | null

The path to background image (default: build/background.tiff or build/background.png if exists). The resolution of this file determines the resolution of the installer window. If background is not specified, use window.size. Default locations expected background size to be 540x380.

See​

DMG with Retina background support.

backgroundColor?​

optional backgroundColor?: string | null

The background color (accepts css colors). Used when no background image is set.

Default​

#ffffff

badgeIcon?​

optional badgeIcon?: string | null

The path to DMG icon (badge icon), which will be shown when mounted, relative to the build resources or to the project directory.

contents?​

optional contents?: DmgContent[]

The content — to customize icon locations. The x and y coordinates refer to the position of the center of the icon (at 1x scale), and do not take the label into account.

format?​

optional format?: "UDRW" | "UDRO" | "UDCO" | "UDZO" | "UDBZ" | "ULFO"

The disk image format. ULFO (lzfse-compressed image (OS X 10.11+ only)).

Default​

UDZO

icon?​

optional icon?: string | null

The path to DMG icon (volume icon), which will be shown when mounted, relative to the build resources or to the project directory. Defaults to the application icon (build/icon.icns).

iconSize?​

readonly optional iconSize?: number | null

The size of all the icons inside the DMG.

Default​

80

iconTextSize?​

readonly optional iconTextSize?: number | null

The size of all the icon texts inside the DMG.

Default​

12

internetEnabled?​

readonly optional internetEnabled?: boolean

Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).

Default​

false

publish?​

optional publish?: Publish

Inherited from​

TargetSpecificOptions.publish

shrink?​

readonly optional shrink?: boolean

Whether to shrink the DMG filesystem to the minimum size after copying files. Set to false to preserve the explicit size you specified.

Default​

true

sign?​

readonly optional sign?: boolean

Whether to sign the DMG or not. Signing is not required and will lead to unwanted errors in combination with notarization requirements.

Default​

false

size?​

readonly optional size?: string | null

The initial size of the DMG filesystem. Accepts the same syntax as the -size argument to hdiutil, e.g. "150m", "4g". If not specified, the size is calculated automatically. Set this explicitly for large apps or apps with sparse files to avoid "No space left on device" errors.

title?​

readonly optional title?: string | null

The title of the produced DMG, which will be shown when mounted (volume name).

Macro ${productName}, ${version} and ${name} are supported.

Default​

${productName} ${version}

window?​

optional window?: DmgWindow

The DMG window position and size. With y co-ordinates running from bottom to top.

The Finder makes sure that the window will be on the user’s display, so if you want your window at the top left of the display you could use "x": 0, "y": 100000 as the x, y co-ordinates. It is not to be possible to position the window relative to the top left or relative to the center of the user’s screen.