Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chipjarred/customtooltip
Easily add custom tool tips with arbitrary content to your AppKit project!
https://github.com/chipjarred/customtooltip
appkit cocoa macapp macos macosx nsview swift swiftpackage tooltip
Last synced: 20 days ago
JSON representation
Easily add custom tool tips with arbitrary content to your AppKit project!
- Host: GitHub
- URL: https://github.com/chipjarred/customtooltip
- Owner: chipjarred
- License: mit
- Created: 2021-04-06T13:30:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-24T02:01:08.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T21:51:37.724Z (about 1 month ago)
- Topics: appkit, cocoa, macapp, macos, macosx, nsview, swift, swiftpackage, tooltip
- Language: Swift
- Homepage:
- Size: 280 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CustomToolTip
CustomToolTip is a Swift Package for macOS Cocoa applications that lets you add tool tips that can use any kind of `NSView` for their content without having to subclass or wrap your existing views. That means it can be easily incorporated into an existing project.
## Project Set Up
- Step 1: Add [https://github.com/chipjarred/CustomToolTip.git](https://github.com/chipjarred/CustomToolTip.git) as a Swift Package dependency to your project in Xcode.
- Step 2: *There is no step 2!*
CustomToolTip provides an extension on `NSView` that handles the rest. You can focus on creating your tool tip content and attach it to your views with the `customToolTip` property that the extension adds to `NSView`.
You don't need to subclass anything. You don't need to nest views in a special tool tip view. You don't even need to change anything in storyboards.
## How to add custom tool tips
In the source files where you want to add custom tool tips,
```swift
import CustomToolTip
```
Then adding a tool tip is as easy as
```swift
myControl.customToolTip = myCustomTipContentView
```
where `myControl`, is the view to which you want to attach a custom tool tip, and `myCustomTipContentView` is any `NSView` you want to use as the tool tip's content.
The only technical requirement for your tool tip view is that its frame size should be properly set before adding it, as the tool tip will adjust its size according to your content view's frame.
There are design considerations for your tool tip content, but those will largely depend on taste, the look and feel of your app, and current thought on good design. The only suggestions I'll make are to keep your tool tips relatively small, and avoid using any view in them that looks like the user should interact with it, because... it's a tool tip. It will disappear when the user moves the mouse.
You can specify the margins between your custom tool tip content view, and the tool tip's window frame:
```swift
myControl.customToolTipMargins = CGSize(width: 5, height: 5)
```
By default CustomToolTip uses the current system window background color for the tool tip's background, but you can use any color you like:
```swift
myControl.customToolTipBackgroundColor = NSColor.blue
```
You can also set the default values to use when you don't specify them per view:
```swift
CustomToolTip.defaultMargins = CGSize(width: 2, height: 2)
CustomToolTip.defaultBackColor = .controlColor
```
## Conveniences
For some especially common cases CustomToolTip provides convenience methods that will make the view for you.
If you just want to add a text tool tip using a specific font, you can do it like this:
```swift
myControl.addCustomToolTip(from: "This is my tool tip", with: NSFont(name: "Chalkboard", size: 20))
```
If you have an `NSAttributedString` you'd like to display in the tool tip, you can use that:
```swift
myControl.addCustomToolTip(from: myAttributedString)
```
To use an `NSImage` as the content:
```swift
myControl.addCustomToolTip(from: myToolTipImage, scaling: .toFit(width: 50, height: 50))
```