🚀
Launch at Startup (macOS, Windows only)
This option lets you specify whether your desktop app should launch when a user starts their computer.
By default, this is disabled for Desktop apps and enabled for Menubar apps.
In your Edit app page, simply check the Launch at Startup By Default checkbox under App Options:

App Options panel for toggling Launch at Startup by Default
If enabled, your desktop app will now launch by default when a user starts up their computer.
Your users will always have an option to toggle this setting on or off in their native app menus (application menu and menubar/tray menu).
We expose a
launchSettings
object and two helper methods if you wish to add custom logic to your app. window.todesktop.app.getLaunchSettings()
returns a promise which resolves to a launchSettings
object. This object has the following attributes:Attribute | Type | Description |
willLaunchAtStartup | boolean | The user's current setting for launching the app at startup. |
const launchSettings = await window.todesktop.app.getLaunchSettings()
console.log(launchSettings);
// {
// willLaunchAtStartup: true
// }
window.todesktop.app.setLaunchSettings(launchSettings)
allows you to update a user's launch settings./*
sets the value of willLaunchAtStartup to true
*/
window.todesktop.app.setLaunchSettings({
willLaunchAtStartup: true
})
The following is an example of how to toggle the status of Launch at Startup if a user clicks on a button.
button.addEventListener('click', () => {
// Gets the launch settings object
const { willLaunchAtStartup } = await window.todesktop.app.getLaunchSettings()
// toggles the value of will launch at startup
window.todesktop.app.setLaunchSettings({
willLaunchAtStartup: !willLaunchAtStartup
})
})
You can learn more about our JavaScript API through the link below:
Last modified 3yr ago