Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dagronf/dsfdocktile

Easily display images, animations, badges and alerts to your macOS application's dock icon
https://github.com/dagronf/dsfdocktile

animation badge custom dock image macos nsdocktile swiftui

Last synced: 16 days ago
JSON representation

Easily display images, animations, badges and alerts to your macOS application's dock icon

Awesome Lists containing this project

README 

        
# DSFDockTile



Easily display images, animations, badges and alerts to your macOS application's dock icon.





    

    

    

    

    

    

        Swift Package Manager




![](https://github.com/dagronf/dagronf.github.io/blob/master/art/projects/DSFDockTile/stitch.gif?raw=true)



## Why?



I was inspired by [Neil Sardesai](https://twitter.com/neilsardesai) after he posted [this on Twitter](https://twitter.com/neilsardesai/status/1362179114204073984?s=20). And this marvellous follow-up tweet by [Norbert M. Doerner](https://twitter.com/cdfinder/status/1365201157854015488?s=20).



While the NSDockTile API isn't overly complex, I wanted something that made it easy to change the dock image, and even add basic animations from GIF images etc.



## Features



* Set the badge label

* Display an image

* Display an animated image

* Display the content of an NSView

* Bounce the docktile 



By default a `DSFDockTile` instance operates on the Application's docktile. You can provide your own `NSDockTile` for any window (by calling `window.dockTile`) via the `init` functions on the badge generators.



## DockTile plugins



Did you know that your application can show a custom DockTile image even when it's not running? Apple provides an `NSDockTilePlugin` prodocol that allows you to do exactly that. Want to provide different application icons for dark and light modes?  `NSDockTilePlugin` allows you to! Want to tweak the dock icon when your application isn't running, but needs attention? `NSDockTilePlugin`!



There is a demo application in the `Demos` folder called **'DSFDockTile Plugin Demo'** (macOS 11+) that demonstrates using `NSDockTilePlugin` and `DSFDockIcon` in SwiftUI.



## Integration



### Swift package manager



Add `https://github.com/dagronf/DSFDockTile` to your project.



If you don't want to include the `DSFImageFlipbook` package, copy all the files in the `Sources/` folder **EXCEPT** for `DSFDockTile+Animation.swift`.



### Demo



There is a demo macOS application available in the `Demos` subfolder.



## Badge Label



It's very easy to add a badge label to a docktile.



```swift

// Set the label on the docktile to 1234

DSFDockTile.badgeLabel = "1234"



// Remove the badge label from the docktile

DSFDockTile.badgeLabel = nil

```



## DockTile Generators



### AppIcon



Set the docktile to the application's icon.



```swift

// Set the dock icon to the application icon

DSFDockTile.AppIcon.display()

```



### Constant Image



This is a `DSFDockTile` object that displays a single image. Useful for if you have a set of images to display in the docktile that do not change and you want to the constantness.



```swift

static let LockedImage   = NSImage(named: NSImage.Name("padlock-locked"))!

static let UnlockedImage = NSImage(named: NSImage.Name("padlock-unlocked"))!



let LockedDockTileImage = DSFDockTile.ConstantImage(LockedImage)

let UnlockedDockTileImage = DSFDockTile.ConstantImage(UnlockedImage)

...



if application.isEditable {

   UnlockedDockTileImage.display()

}

else {

   LockedDockTileImage.display()

}

```



### Image



This is a `DSFDockTile` object that can display images.



```swift

static let LockedImage   = NSImage(named: NSImage.Name("padlock-locked"))!

static let UnlockedImage = NSImage(named: NSImage.Name("padlock-unlocked"))!



let stateDockTile = DSFDockTile.Image()



...



func viewDidLoad() {

   let image = application.isEditable ? UnlockedImage : LockedImage

   stateDockTile.display(image)

}

```



### View



This is a `DSFDockTile` object that can display the content of a view managed by a view controller



Due to NSDockTile restrictions, the view is not drawn live into the dock as the view is updated. You must call `display()` to update the dock tile with the view's current content whenever a change occurs in the view.



```swift

/// The view controller to display on the docktile

let dockViewController = DockViewController()



/// The docktile instance handling the docktile

lazy var updateDockTile: DSFDockTile.View = {

   dockViewController.loadView()

   return DSFDockTile.View(dockViewController)

}()

...

func doUpdate() {

   // Change the color of the item in the 

   self.dockViewController.foregroundColor = .systemYellow



   // NSDockTile does not update automatically so need to tell it when changes are made

   self.updateDockTile.display()

}

```



### Animation



This is a docktile that can display an animation.  It uses `DSFImageFlipbook` under the seams to handle the animation itself.



```swift

let animatedDockTile: DSFDockTile.Animated = {

   let fb = DSFImageFlipbook()

   let da = NSDataAsset(name: NSDataAsset.Name("animated-gif"))!

   _ = fb.loadFrames(from: da.data)

   return DSFDockTile.Animated(fb)

}()



...



@IBAction func startAnimating(_ sender: Any) {

   animatedDockTile.startAnimating()

}



@IBAction func stopAnimating(_ sender: Any) {

   animatedDockTile.stopAnimating()

}

```



## SwiftUI 



The `DockTile` view is used to manipulate the docktile for



* The application (`.application`)

* The window containing the `DockTile` View (`.window`)



You can set which docktile you want to update in the initializer of the `DockTile` View 



### Updating the badge



To set a badge using SwiftUI, use the `DockTile` view and provide a label for the badge



```swift

@State var badgeLabel: String = ""

var body: some Scene {

   WindowGroup {

      ZStack {

         ContentView()

         DockTile(label: badgeLabel)

      }

   }

}

```



### Updating the content



To set the content of a dock tile, provide a view to the initializer. Set to `nil` to return the docktile to its default. 



```swift

@State var dockText: String = ""

var body: some Scene {

   WindowGroup {

      ZStack {

         ContentView()

         DockTile(

            .window,

            label: "3",

            content: ZStack {

               Color.white

               Text(dockText)

            }

         )

      }

   }

}

```



Remember that the DockTile API does not provide live docktile updating, and will require you to update the view for each 

visual change you want to make



## Attention Concepts



You can request user information via the DockTile of an application if your application is not the front-most application.



See [Apple's Documentation](https://developer.apple.com/documentation/appkit/nsapplication/1428358-requestuserattention) for more details.



### requestInformationalAttention()



Request that the docktile 'bounce' to inform the user of something informational. The function returns an object which you can use to cancel the attention request.



```swift

let cancellable = DSFDockTile.requestInformationalAttention()

```



The `cancellable` can be used to cancel the information request.



See [Apple's Documentation](https://developer.apple.com/documentation/appkit/nsapplication/requestuserattentiontype/criticalrequest)



### requestCriticalAttention()



Request that the docktile 'bounce' to inform the user of something informational. The function returns an object which you can use to cancel the attention request.



```swift

let cancellable = DSFDockTile.requestCriticalAttention()

```



The `cancellable` can be used to cancel the critical request.



See [Apple's Documentation](https://developer.apple.com/documentation/appkit/nsapplication/requestuserattentiontype/informationalrequest)



### Cancellation protocol (DSFDockTileUserAttentionCancellation)



The user attention methods return an object that conforms to `DSFDockTileUserAttentionCancellation` that can be used to cancel an attention request.



See [Apple's Documentation](https://developer.apple.com/documentation/appkit/nsapplication/1428683-canceluserattentionrequest)



## Thanks



* [Neil Sardesai](https://twitter.com/neilsardesai)

* [Norbert M. Doerner](https://twitter.com/cdfinder)

* The images (light/dark) in the demo application are thanks to [brgfx on freepix](https://www.freepik.com/free-vector/opposite-adjectives-light-dark_1172843.htm)

  * Attribution - Background vector created by brgfx - www.freepik.com



* Here is the project I used to understand how to use `NSDockTilePlugin` for my own project. [https://github.com/rrroyal/AutomaticDockTile](https://github.com/rrroyal/AutomaticDockTile)



## License



MIT. Use it and abuse it for anything you want, just attribute my work. Let me know if you do use it somewhere, I'd love to hear about it!



```

MIT License



Copyright (c) 2022 Darren Ford



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

```