ThemeManager

ThemeManager shared manager.

public static let shared = ThemeManager()

Enables or disables ThemeKit functionality.

@objc public var isEnabled: Bool

Sets or returns the current theme.

This property is KVO compliant. Value is stored on user defaults under key userDefaultsThemeKey.

@objc public var theme: Theme

Returns the current effective theme (read-only).

This property is KVO compliant. This can return a different result than theme, as if current theme is set to SystemTheme, effective theme will be either lightTheme or darkTheme, respecting user preference at System Preferences > General > Appearance.

@objc public var effectiveTheme: Theme

List all available themes:

• Built-in lightTheme
• Built-in darkTheme
• Built-in systemTheme
• All native themes (extending NSObject and conforming to Theme protocol)
• All user themes (loaded from .theme files)

This property is KVO compliant and will change when changes occur on user themes folder.

@objc public var themes: [Theme]

List all user themes (UserTheme class, loaded from .theme files)

@objc public var userThemes: [Theme]

Convenience method for accessing the light theme.

This property can be changed so that SystemTheme resolves to this theme instead of the default LightTheme.

@objc public static var lightTheme: Theme = LightTheme()

Convenience method for accessing the dark theme.

This property can be changed so that SystemTheme resolves to this theme instead of the default DarkTheme.

@objc public static var darkTheme: Theme = DarkTheme()

Convenience method for accessing the theme that dynamically changes to ThemeManager.lightTheme or ThemeManager.darkTheme, respecting user preference at System Preferences > General > Appearance.

@objc public static let systemTheme = SystemTheme()

Set/get default theme to be used on the first run (default: ThemeManager.systemTheme).

@objc public static var defaultTheme: Theme = ThemeManager.systemTheme

Get the theme with specified identifier.

@objc public func theme(withIdentifier identifier: String?) -> Theme?

User defaults key for current theme.

Current theme.identifier will be stored under the "ThemeKitTheme" NSUserDefaults key.

@objc static public let userDefaultsThemeKey = "ThemeKitTheme"

Apply last applied theme, or default, if none.

Get last applied theme from user defaults and load it. If no theme was previously applied, load the default theme (ThemeManager.defaultTheme).

@objc public func applyLastOrDefaultTheme()

Force-apply current theme.

Normally you should not need to invoke this method, as this will force-apply the same theme.

@objc public func reApplyCurrentTheme()

Location of user provided themes (.theme files).

Ideally, this should be on a shared location, like Application Support/{app_bundle_id}/Themes for example. Here’s an example of how to get this folder (*):

public var applicationSupportUserThemesFolderURL: URL {
  let applicationSupportURLs = NSSearchPathForDirectoriesInDomains(.applicationSupportDirectory, .userDomainMask, true)
  let thisAppSupportURL = URL(fileURLWithPath: applicationSupportURLs.first!).appendingPathComponent(Bundle.main.bundleIdentifier!)
  return thisAppSupportURL.appendingPathComponent("Themes")
}

*: force wrapping (!) is for illustrative purposes only.

You can also bundle these files with your application bundle, if you don’t want them to be changed.

@objc public var userThemesFolderURL: URL?

Appearance in use for effective theme.

@objc public var effectiveThemeAppearance: NSAppearance

Convenience method to get the light appearance.

@objc public var lightAppearance: NSAppearance?

Convenience method to get the dark appearance.

@objc public var darkAppearance: NSAppearance?

Window theme policies that define which windows should be automatically themed, if any.

Swift

By default, all application windows (except NSPanel) will be themed (.themeAllWindows).

• themeAllWindows: Theme all application windows, except NSPanel subclasses (default).
• themeSomeWindows: Only theme windows of the specified classes.
• doNotThemeSomeWindows: Do not theme windows of the specified classes.
• doNotThemeWindows: Do not theme any window.E.g.:

E.g.:

ThemeManager.shared.windowThemePolicy = .themeSomeWindows(windowClasses: [CustomWindow.self])

Objective-C

By default, all application windows (except NSPanel) will be themed (TKThemeManagerWindowThemePolicyThemeAllWindows).

• TKThemeManagerWindowThemePolicyThemeAllWindows: Theme all application windows, except NSPanel subclasses (default).
• TKThemeManagerWindowThemePolicyThemeSomeWindows: Only theme windows of the specified classes (use themableWindowClasses property).
• TKThemeManagerWindowThemePolicyDoNotThemeSomeWindows: Do not theme windows of the specified classes (use notThemableWindowClasses property).
• TKThemeManagerWindowThemePolicyDoNotThemeWindows: Do not theme any window.

Example:

[TKThemeManager sharedManager].windowThemePolicy = TKThemeManagerWindowThemePolicyThemeSomeWindows;
[TKThemeManager sharedManager].themableWindowClasses = @[[CustomWindow class]];

NSWindow Extension

• NSWindow.theme()

  Theme window if appearance needs update. Doesn’t check for policy compliance.

• NSWindow.isCompliantWithWindowThemePolicy()

  Check if window complies to current policy.

• NSWindow.themeIfCompliantWithWindowThemePolicy()

  Theme window if compliant to windowThemePolicy (and if appearance needs update).

• NSWindow.themeAllWindows()

  Theme all windows compliant to ThemeManager.windowThemePolicy (and if appearance needs update).

See more

public enum WindowThemePolicy

Current window theme policy.

public var windowThemePolicy: WindowThemePolicy = .themeAllWindows

Animate theme transitions?

@objc public var animateThemeTransitions: Bool = true

ThemeKit notification sent when current theme is about to change.

@objc public static let willChangeThemeNotification = Notification.Name.willChangeTheme

ThemeKit notification sent when current theme did change.

@objc public static let didChangeThemeNotification = Notification.Name.didChangeTheme

ThemeKit notification sent when system theme did change (System Preference > General > Appearance).

@objc public static let didChangeSystemThemeNotification = Notification.Name.didChangeSystemTheme