Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yannxou/taptempobutton

SwiftUI View to easily add tap tempo functionality to music apps.
https://github.com/yannxou/taptempobutton

catalyst ios macos macos-catalyst music music-library swift swift-package swiftui swiftui-controls tvos watchos xcode

Last synced: about 7 hours ago
JSON representation

SwiftUI View to easily add tap tempo functionality to music apps.

Host: GitHub
URL: https://github.com/yannxou/taptempobutton
Owner: yannxou
License: mit
Created: 2023-01-10T18:48:41.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-16T22:25:53.000Z (about 2 years ago)
Last Synced: 2025-01-09T04:35:47.231Z (13 days ago)
Topics: catalyst, ios, macos, macos-catalyst, music, music-library, swift, swift-package, swiftui, swiftui-controls, tvos, watchos, xcode
Language: Swift
Homepage:
Size: 35.2 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# TapTempoButton

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fyannxou%2FTapTempoButton%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/yannxou/TapTempoButton)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fyannxou%2FTapTempoButton%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/yannxou/TapTempoButton)

A SwiftUI View that easily brings tap tempo functionality to music apps.

## How it works

The `TapTempoButton` takes a content closure so it can be customized. The whole view will handle the tap events automatically and calculate the tempo average (in BPM) which is sent in the `onTempoChange` closure on each change.

Rather than processing the touch events like a standard Button (on touch up) the view handles them on touch down so the button behaviour is more natural in a musical context.

![TapTempoButtonPreview](https://user-images.githubusercontent.com/5954961/211922448-172522bc-1a81-4b15-b7e7-606e54efdc59.gif)

## Usage

Add the `TapTempoButton` to your View and customize it with the content closure.

```swift
TapTempoButton(onTempoChange: {
self.tempo = $0
}) {
Text("Tap")
}
```

It can also be customized like a regular SwiftUI Button:

```swift
.buttonBorderShape(.capsule)
.buttonStyle(.bordered)
```

```swift
.buttonStyle(MyButtonStyle())
```

### Configuration

The following properties can be configured on initialization:

* `tempoRange`: Defines the minimum and maximum tempo that can be detected.
* `timeout`: Seconds of inactivity after which the ongoing detection will be restarted.
* `minTaps`: Minimum number of taps required before sending values to the `onTempoChange` closure.
* `roundDecimals`: Number of decimals to round the BPM to. Set to `0` for integer-only BPM (no decimals). Set to `nil` to disable rounding.

## Installation

1. From the File menu, select Add Packages...
2. Enter package repository URL: https://github.com/yannxou/TapTempoButton
3. Confirm the version and let Xcode resolve the package

## Support

The idea for this library appeared while working on the app [Vetro: Visual Metronome](https://apps.apple.com/app/vetro-visual-metronome/id1637121079) for iOS/macOS. If you like it you can support us by buying any of [our apps](https://apps.apple.com/es/developer/natalia-artigas/id957299596).

## License

This library is released under the MIT license. See [LICENSE](LICENSE) for details.