https://github.com/perseusrealdeal/perseusdarkmode
Swift Dark Mode lib. macOS 10.9+, iOS 9.3+, Xcode 10.1+.
https://github.com/perseusrealdeal/perseusdarkmode
apple carthage cocoa cocoapods dark-mode ios ios-swift macos macos-swift package standalone swift swift-package-manager uikit
Last synced: 3 months ago
JSON representation
Swift Dark Mode lib. macOS 10.9+, iOS 9.3+, Xcode 10.1+.
- Host: GitHub
- URL: https://github.com/perseusrealdeal/perseusdarkmode
- Owner: perseusrealdeal
- License: other
- Created: 2022-02-24T09:33:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T07:45:28.000Z (about 1 year ago)
- Last Synced: 2025-04-22T07:50:31.729Z (about 1 year ago)
- Topics: apple, carthage, cocoa, cocoapods, dark-mode, ios, ios-swift, macos, macos-swift, package, standalone, swift, swift-package-manager, uikit
- Language: Swift
- Homepage:
- Size: 339 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Perseus Dark Mode
[](https://github.com/perseusrealdeal/PerseusDarkMode/actions)
[](/PerseusDarkMode.podspec)
[](https://docs.swift.org/swift-book/RevisionHistory/RevisionHistory.html)
[](/LICENSE)
## Integration Capabilities
[](/PerseusDarkModeSingle.swift)
[](https://github.com/Carthage/Carthage)
[](/PerseusDarkMode.podspec)
[](/Package.swift)
## Demo Apps and Others
[](https://github.com/perseusrealdeal/ios.darkmode.discovery.git)
[](https://github.com/perseusrealdeal/macos.darkmode.discovery.git)
[](https://github.com/perseusrealdeal/PerseusUISystemKit.git)
[](https://github.com/perseusrealdeal/XcodeTemplateProject.git)
# In Brief
> This library lets a developer being awared of Dark Mode via a variable `DarkMode.style`. Also, with this library it is possible to change the value of Dark Mode in runtime easily with standalone lib [DarkModeSwitching](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706).
```swift
changeDarkModeManually(.off) // .on or .auto
```
Sample screen for changing Dark Mode option [here for macOS](https://github.com/perseusrealdeal/macos.darkmode.discovery) and [here for iOS](https://github.com/perseusrealdeal/ios.darkmode.discovery).
# Reqirements
- Xcode 10.1+
- Swift 4.2+
- iOS: 9.3+, UIKit SDK
- macOS: 10.9+, AppKit SDK
# First-party software
- [PerseusLogger](https://gist.github.com/perseusrealdeal/df456a9825fcface44eca738056eb6d5)
# Third-party software
- [SwiftLint Shell Script Runner](/SucceedsPostAction.sh)
- [SwiftLint](https://github.com/realm/SwiftLint) / [0.31.0: Busy Laundromat](https://github.com/realm/SwiftLint/releases/tag/0.31.0) for macOS High Sierra
# Installation
> ***Using "Exact" with the Version field is strongly recommended.***
## Step 1: Add PerseusDarkMode to a host project tree
### Standalone
Make a copy of the file [`PerseusDarkModeSingle.swift`](/PerseusDarkModeSingle.swift) then put it into a place required of a host project.
### Carthage
Cartfile should contain:
```carthage
github "perseusrealdeal/PerseusDarkMode" == 1.1.5
```
Some Carthage usage tips placed [here](https://gist.github.com/perseusrealdeal/8951b10f4330325df6347aaaa79d3cf2).
### CocoaPods
Podfile should contain:
```ruby
target "ProjectTarget" do
use_frameworks!
pod 'PerseusDarkMode', '1.1.4'
end
```
### Swift Package Manager
- As a package dependency so Package.swift should contain the following statements:
```swift
dependencies: [
.package(url: "https://github.com/perseusrealdeal/PerseusDarkMode.git",
.exact("1.1.5"))
],
```
- As an Xcode project dependency:
`Project in the Navigator > Package Dependencies > Add Package Dependency`
> ***Using "Exact" with the Version field is strongly recommended.***
## Step 2: Make DarkMode ready for using
### iOS
Override the following method of the first screen to let Perseus know that system's appearance changed:
```swift
class MainViewController: UIViewController {
override func traitCollectionDidChange(_ previousTraitCollection: UITraitCollection?) {
super.traitCollectionDidChange(previousTraitCollection)
if #available(iOS 13.0, *) {
AppearanceService.processTraitCollectionDidChange(previousTraitCollection)
}
}
}
```
Also, if Dark Mode is released with Settings bundle put the statements into the app's delegate:
```swift
extension AppDelegate: UIApplicationDelegate {
func applicationDidBecomeActive(_ application: UIApplication) {
// Update Dark Mode from Settings
if let choice = isDarkModeSettingsChanged() {
// Change Dark Mode value in Perseus Dark Mode library
AppearanceService.DarkModeUserChoice = choice
// Update appearance in accoring with changed Dark Mode Style
AppearanceService.makeUp()
}
}
}
```
Used functions are distributed via standalone file [`DarkModeSwitching.swift`](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706).
### iOS and macOS
Call the method `AppearanceService.makeUp()` with the app's delegate if appearance changing is going to take place:
```swift
extension AppDelegate: UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions
launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// ... code
// Call AppearanceService.makeUp() method if AppearanceService.register(:, :)
// is taken into account
AppearanceService.makeUp()
// ... otherwise call AppearanceService.recalculateStyleIfNeeded()
// to load DarkMode.style from user defaults
// AppearanceService.recalculateStyleIfNeeded()
}
}
```
Copy the file [`DarkModeSwitching.swift`](https://gist.github.com/perseusrealdeal/11b1bab47f13134832b859f49d9af706) into a host project for having fun with manual changing Dark Mode value.
# Usage
Each time if Dark Mode changed the mentioned method `#selector(makeUp)` called, but registering is required:
```swift
class MainViewController: UIViewController {
// At any view controller where changing is required
override func viewDidLoad() {
super.viewDidLoad()
AppearanceService.register(stakeholder: self, selector: #selector(makeUp))
}
@objc private func makeUp() {
print("^_^ \(AppearanceService.DarkModeUserChoice)"
switch DarkMode.style {
case .light:
// make drawings for light mode
break
case .dark:
// make drawings for dark mode
break
}
}
}
```
There is another way to be notified of Dark Mode—KVO.
> [`DarkModeImageView`](https://github.com/perseusrealdeal/PerseusUISystemKit/blob/master/Sources/PerseusUISystemKit/Classes/DarkModeImageView.swift) class is an expressive sample of Dark Mode KVO usage for both macOS and iOS as well.
# License MIT
Copyright © 7530 - 7531 Mikhail Zhigulin of Novosibirsk.
- The year starts from the creation of the world according to a Slavic calendar.
- September, the 1st of Slavic year.
[LICENSE](/LICENSE) for details.
# Author
> `PerseusDarkMode` was written at Novosibirsk by Mikhail Zhigulin i.e. me, mzhigulin@gmail.com.
> Mostly I'd like thank my lovely parents for supporting me in all my ways.