Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dagronf/dsftogglebutton

A macOS toggle button (inheriting from NSButton) that mimics iOS's UISwitch
https://github.com/dagronf/dsftogglebutton

appkit button cocoa macos objective-c swift toggle

Last synced: 2 months ago
JSON representation

A macOS toggle button (inheriting from NSButton) that mimics iOS's UISwitch

Host: GitHub
URL: https://github.com/dagronf/dsftogglebutton
Owner: dagronf
License: mit
Created: 2020-02-17T08:16:02.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-07-20T07:59:25.000Z (6 months ago)
Last Synced: 2024-09-20T09:32:23.506Z (3 months ago)
Topics: appkit, button, cocoa, macos, objective-c, swift, toggle
Language: Swift
Homepage:
Size: 114 KB
Stars: 14
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# DSFToggleButton

![](https://github.com/dagronf/dagronf.github.io/raw/master/art/projects/DSFToggleButton/primary.png)

A macOS NSSwitch-style toggle button scalable to any size. Supports Swift, SwiftUI and Objective-C.

![](https://img.shields.io/github/v/tag/dagronf/DSFToggleButton) ![](https://img.shields.io/badge/macOS-10.13+-red) ![](https://img.shields.io/badge/Swift-5.0+-orange.svg)
![](https://img.shields.io/badge/License-MIT-lightgrey) [![](https://img.shields.io/badge/spm-compatible-brightgreen.svg?style=flat)](https://swift.org/package-manager)

# Why

Because sometimes all you want is a nice, big, very visible toggle button/checkbox.

## Adding to your project

### Swift Package Manager

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

## Usage

Since `DSFToggleButton` inherits from `NSButton`, its behaviour is the same as for a regular checkbox. You can programatically set the state or its enabled states just as you would for an `NSButton` for example, including manual bindings.

The control itself does not define its size, so you can make it as big or as small as you'd like. As all the drawing is scalable, the control will look great at any size you want.

### Interface builder

Drop in a new custom view into your canvas and set its class to `DSFToggleButton`.

## Configuration

| Variable | Type | Description |
|----------------|-----------|------------------------------------------------------------------------------------|
| `color` | `NSColor` | The color of the button when the state is on, defaults to the off background color |
| `showLabels` | `Bool` | Show labels (0 and 1) on the button to increase visual distinction between states |
| `animated` | `Bool` | Whether to animate state changes |
| `highContrast` | `Bool` | Remove any visual flourishes on the control |

| Callback | Description |
|-----------|-----------------------------------------------------------------------------------|
| `stateChangeBlock` | A block-based callback mechanism (optional) which will be called whenever the button state changes |

# Screenshots

### Dark mode, green (no labels)

![](https://github.com/dagronf/dagronf.github.io/raw/master/art/projects/DSFToggleButton/green_toggle.gif)

### Dark mode, blue with labels

![](https://github.com/dagronf/dagronf.github.io/raw/master/art/projects/DSFToggleButton/blue_toggle_labels.gif)

### Light mode with labels, high contrast

![](https://github.com/dagronf/dagronf.github.io/raw/master/art/projects/DSFToggleButton/gray_toggle_high_contrast.gif)

### Interface Builder

![](https://github.com/dagronf/dagronf.github.io/raw/master/art/projects/DSFToggleButton/interface_builder.png)

# License

```
MIT License

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.
```