https://github.com/regexident/gestalt

An unintrusive & light-weight iOS app-theming library with support for animated theme switching.
https://github.com/regexident/gestalt

darkmode ios theme theme-switcher

Last synced: 7 days ago
JSON representation

An unintrusive & light-weight iOS app-theming library with support for animated theme switching.

• Host: GitHub
• URL: https://github.com/regexident/gestalt
• Owner: regexident
• License: mpl-2.0
• Created: 2017-07-04T10:58:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-12-14T11:12:31.000Z (almost 4 years ago)
• Last Synced: 2024-10-13T16:16:28.953Z (about 1 month ago)
• Topics: darkmode, ios, theme, theme-switcher
• Language: Swift
• Homepage:
• Size: 3.49 MB
• Stars: 326
• Watchers: 6
• Forks: 21
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![jumbotron](jumbotron.png)

# Gestalt

**Gestalt** is an **unintrusive** and **light-weight** framework for **application theming** with support for **animated theme switching**.

![screencast](screencast.gif)

## Usage

Let's say you want to theme a view controller with a single label:

```swift

import Gestalt

struct Theme: Gestalt.Theme {

    let view: ViewTheme = .init()

    static let light: Theme = .init(view: .light)

    static let dark: Theme = .init(view: .dark)

}

struct ViewTheme: Gestalt.Theme {

    let font = UIFont.preferredFont(forTextStyle: .headline)

    let color: UIColor

    let backgroundColor: UIColor

    static let light: Theme = .init(

        color: UIColor.black

        backgroundColor: UIColor.white

    )

    static let dark: Theme = .init(

        color: UIColor.white

        backgroundColor: UIColor.black

    )

}

// In `AppDelegate.application(_:didFinishLaunchingWithOptions:)`

// assign a default theme (or user's choice from user defaults):

ThemeManager.default.theme = Theme.light

class ViewController: UIViewController {

    @IBOutlet var label: UILabel!

    override func viewDidLoad() {

        super.viewDidLoad()

        

        self.observe(theme: \Theme.view)

    }

}

extension ViewController: Themeable {

    typealias Theme = ViewTheme

    func apply(theme: Theme) {

        self.view.backgroundColor = theme.backgroundColor

        self.label.textColor = theme.color

        self.label.font = theme.font

    }

}

```

The call `self.observe(theme: \Theme.view)` registers the receiver for theme observation on `ThemeManager.default` for future theme changes and then calls it once immediately. The initial call is not animated, any further changes however are animated.

To change the current theme (even while the app is running) simply assign a different theme to your given `ThemeManager` in use:

```swift

ThemeManager.default.theme = Theme.dark

```

This will cause all previously registered closures on the given `ThemeManager` to be called again.

See the `GestaltDemo` target for a more realistic/elaborate usage example.

#### Note:

1. It is generally sufficient to use `ThemeManager.default`. It is however possible to create dedicated `ThemeManager`s via `let manager = ThemeManager()`.

### Usage in App Extensions

The use appearance proxies after a view has already been loaded this library uses a hack that removes and re-adds the root view of the application from the main window to activate the proxies. This is not possible in app extensions, such as a today widget, because the extension safe API restricts access to the main window. So to use this library in app extensions you need to manually trigger the reload of the root view by adding something like this to your root view controller after you set up your themes.

```

ThemeManager.default.observe(theme: Theme.self) { [weak self] _ in

        if let strongSelf = self, let superview = strongSelf.view.superview {

            strongSelf.view.removeFromSuperview()

            superview.addSubview(strongSelf.view)

        }

    }

```

#### Important:

1. The body of `func apply(theme: Theme)` should be [idempotent](https://en.wikipedia.org/wiki/Idempotence) to avoid unwanted side-effects on repeated calls.

## Installation

The recommended way to add **Gestalt** to your project is via [Carthage](https://github.com/Carthage/Carthage):

    github 'regexident/Gestalt' ~> 2.0.0

    

or via [Cocoapods](https://cocoapods.org):

    pod 'Gestalt', '~> 2.0.0'

or via [Swift Package Manager](https://swift.org):

```swift

let package = Package(

    name: "GestaltDemo",

    dependencies: [

        .package(url: "https://github.com/regexident/Gestalt.git", from: "2.0.0")

    ],

    targets: [

        .target(name: "GestaltDemo", dependencies: [ "Gestalt" ])

    ]

)

```

## License

**Gestalt** is available under the **MPL-2.0 license**. See the `LICENSE` file for more info.