https://github.com/ChimeHQ/NicerTouchBar

Utilities for a more pleasant NSTouchBar development experience
https://github.com/ChimeHQ/NicerTouchBar

appkit macos swift touchbar

Last synced: about 2 months ago
JSON representation

Utilities for a more pleasant NSTouchBar development experience

• Host: GitHub
• URL: https://github.com/ChimeHQ/NicerTouchBar
• Owner: ChimeHQ
• License: bsd-3-clause
• Archived: true
• Created: 2018-12-16T21:16:23.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T18:44:15.000Z (3 months ago)
• Last Synced: 2024-08-06T21:33:13.762Z (about 2 months ago)
• Topics: appkit, macos, swift, touchbar
• Language: Swift
• Size: 50.8 KB
• Stars: 34
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


[![Build Status][build status badge]][build status]

[![Platforms][platforms badge]][platforms]



# NicerTouchBar

NicerTouchBar includes useful utilities for `NSTouchBar`/`NSTouchBarItem` validation, as well as some convenience methods for influencing `NSTouchBar` behavior/setup.

## Validation

While we have `NSMenuItemValidation` and `NSUserInterfaceValidations`, as of 10.15, `NSTouchBar` doesn't have a good validation system. This library introduces a `TouchBarItemValidations` protocol, which is checked first during the touch bar validation process. As a fallback, `NSUserInterfaceValidations` is checked if appropriate.

```swift

public protocol TouchBarItemValidations {

    @available(OSX 10.12.2, *)

    func validateTouchBarItem(_ item: NSTouchBarItem) -> Bool

}

```

Validation is `NSTouchBarItem`-subclass dependent. Currently, `NSGroupTouchBarItem` and `NSPopoverTouchBarItem` are supported. `NSCustomTouchBarItem` is supported **if** its view property is a subclass of `NSControl`.

## Triggering Validation

Because this validation isn't provided by the system, you have to do some work to wire it up. You can just use the `validate` method on `NSTouchBar` directly. This is manual, but can be efficient, especially if your validation needs are simple.

A fancier way is to hook into NSWindow/NSApplication's `didUpdateNotification`. This gives you a easy way to run your validation automatically as the window/app processes events.

And, as a convenience, there are a few functions/extensions that make it easier to manually validate.

```swift

class MyViewController: NSViewController {

    func myFunction() {

        // this can be called safely before 10.12.2

        validateTouchBar()

        // or (cannot be called before 10.12.2)

        touchbar?.validate()

    }

}

```

## Overriding a Window's TouchBar

It sometimes happens that you need to override a window's default touch bar. Instead of messing with binding, you can use a handy extension on `NSViewController`.

```swift

deinit {

    restoreParentWindowTouchBar()

}

override func viewWillAppear() {

    super.viewWillAppear()

    becomeParentWindowTouchBarProvider()

}

```

### Installation

```swift

dependencies: [

    .package(url: "https://github.com/ChimeHQ/NicerTouchBar")

]

```

### Suggestions or Feedback

We'd love to hear from you! Get in touch via an issue or pull request.

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

[build status]: https://github.com/ChimeHQ/NicerTouchBar/actions

[build status badge]: https://github.com/ChimeHQ/NicerTouchBar/workflows/CI/badge.svg

[platforms]: https://swiftpackageindex.com/ChimeHQ/NicerTouchBar

[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FNicerTouchBar%2Fbadge%3Ftype%3Dplatforms