sindresorhus/launchatlogin-modern

Add “Launch at Login” functionality to your macOS app in seconds

LaunchAtLogin

Add “Launch at Login” functionality to your macOS app in seconds

This package is meant for apps targeting macOS 13 or later. If you need backwards-compatibility, check out the old LaunchAtLogin package.

Requirements

macOS 13+

Install

Add https://github.com/sindresorhus/LaunchAtLogin-Modern in the “Swift Package Manager” tab in Xcode.

Usage

Put the toggle in your Settings scene. That's it.

import SwiftUI
import LaunchAtLogin

@main
struct MyApp: App {
	var body: some Scene {
		Settings {
			Form {
				LaunchAtLogin.Toggle()
			}
		}
	}
}

The LaunchAtLogin.Toggle view works similarly to the built-in Toggle except that is has a predefined binding and label.

The default label is "Launch at login", but it can be overridden:

import SwiftUI
import LaunchAtLogin

struct SettingsScreen: View {
	var body: some View {
		LaunchAtLogin.Toggle("Launch at login 🦄")

		// Or
		LaunchAtLogin.Toggle {
			Text("Launch at login 🦄")
		}
	}
}

You can also access the state directly:

import LaunchAtLogin

print(LaunchAtLogin.isEnabled)
//=> false

LaunchAtLogin.isEnabled = true

print(LaunchAtLogin.isEnabled)
//=> true

Note

The Mac App Store guidelines require “launch at login” functionality to be enabled in response to a user action. Your app will be rejected if you set the state to true by default.

FAQ

How is this different from the old package?

This is a new repo as the old package had a lot of bloat in its Git history. I also took the opportunity to make a more minimal API optimized for SwiftUI apps.

Related

• Defaults - Swifty and modern UserDefaults
• KeyboardShortcuts - Add user-customizable global keyboard shortcuts to your macOS app
• DockProgress - Show progress in your app's Dock icon
• More…

launchatlogin-modern's Issues

'mainApp' is only available in Mac Catalyst 16.0 or newer

Hello, if I want to use LaunchAtLogin in a catalyst app, it only seems possible since 16.0, otherwise there are build errors 'mainApp' is only available in Mac Catalyst 16.0 or newer.

Could you please update Package.swift to reflect this (I don't have experience with authoring swift packages)?

not working for test flight builds.

I have implement this in my app which is working correctly in the device in which I have created the app. I have tested this by exporting app in my device but as soon as I upload the same on ten flight and I download it in another device and the app is not restarting by it self in that device after login though it is showing in system preferences in login items

Multi-platform build support

Perhaps I'm approaching this incorrectly, but I'm having problems previewing SwiftUI for iOS while this package is added to the project.

I have disabled LaunchAtLogin and MenuBarExtraAccess for iOS like this:

This makes it possible to build the project for iOS, but I still get a crash when previewing.

Any ideas on how to make previews work would be amazing. Otherwise, and it probably makes little sense for you to do it since this is explicitly a macOS package, adding #if os(macOS) around the code in this package and MenuBarExtraAccess, would make the package build on iOS.

Thank you

How to listen to toggle changed event?

The older version of LaunchAtLogin has an observable property that can be used to listen to change events.

How can I achieve the same with this version?