Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Mijick/Timer
Modern API for Timer
https://github.com/Mijick/Timer
ios ios-sdk ios-swift spm swift swift-package swift-package-manager swift5 swiftlibrary swiftui swiftui-framework timer
Last synced: 3 months ago
JSON representation
Modern API for Timer
- Host: GitHub
- URL: https://github.com/Mijick/Timer
- Owner: Mijick
- License: mit
- Created: 2023-09-21T16:11:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T19:05:18.000Z (3 months ago)
- Last Synced: 2024-07-30T23:28:48.014Z (3 months ago)
- Topics: ios, ios-sdk, ios-swift, spm, swift, swift-package, swift-package-manager, swift5, swiftlibrary, swiftui, swiftui-framework, timer
- Language: Swift
- Homepage:
- Size: 11.7 KB
- Stars: 91
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-swiftui-libraries - MijickTimer - Modern API for Timer (Extensions / Content)
README
Modern API for Timer
Easy to use yet powerful Timer library. Keep your code clean
Try demo we prepared
|
Roadmap
|
Propose a new feature
Timer is a free and open-source library dedicated for Swift that makes the process of handling timers easier and much cleaner.
* **Improves code quality.** Start timer using the `publish().start()` method. Stop the timer with `stop()`. Simple as never.
* **Run your timer in both directions.** Our Timer can operate in both modes (increasing or decreasing).
* **Supports background mode.** Don't worry about the timer when the app goes into the background. We handled it!
* **And much more.** Our library allows you to convert the current time to a string or to display the timer progress in no time.
# Getting Started
### ✋ Requirements
| **Platforms** | **Minimum Swift Version** |
|:----------|:----------|
| iOS 13+ | 5.0 |
| iPadOS 13+ | 5.0 |
| macOS 10.15+ | 5.0 |
### ⏳ Installation
#### [Swift package manager][spm]
Swift package manager is a tool for automating the distribution of Swift code and is integrated into the Swift compiler.
Once you have your Swift package set up, adding Timer as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```Swift
dependencies: [
.package(url: "https://github.com/Mijick/Timer", branch(“main”))
]
```
#### [Cocoapods][cocoapods]
Cocoapods is a dependency manager for Swift and Objective-C Cocoa projects that helps to scale them elegantly.
Installation steps:
- Install CocoaPods 1.10.0 (or later)
- [Generate CocoaPods][generate_cocoapods] for your project
```Swift
pod init
```
- Add CocoaPods dependency into your `Podfile`
```Swift
pod 'MijickTimer'
```
- Install dependency and generate `.xcworkspace` file
```Swift
pod install
```
- Use new XCode project file `.xcworkspace`
# Usage
### 1. Initialise the timer
Call the `publish()` method that has three parameters:
* **time** - The number of seconds between firings of the timer.
* **tolerance** - The number of seconds after the update date that the timer may fire.
* **currentTime** - The current timer time.
```Swift
try! MTimer.publish(every: 1, currentTime: $currentTime)
```
### 2. Start the timer
Start the timer using the `start()` method. You can customise the start and end time using the parameters of this method.
```Swift
try! MTimer
.publish(every: 1, currentTime: $currentTime)
.start(from: .init(minutes: 21, seconds: 37), to: .zero)
```
### 3. *(Optional)* Observe TimerStatus and TimerProgress
You can observe changes in both values by calling either of the methods
```Swift
try! MTimer
.publish(every: 1, currentTime: $currentTime)
.bindTimerStatus(isTimerRunning: $isTimerRunning)
.bindTimerProgress(progress: $timerProgress)
.start(from: .init(minutes: 21, seconds: 37), to: .zero)
```
### 4. Stop the timer
Timer can be stopped with `stop()` method.
```Swift
MTimer.stop()
```
### 5. Additional timer controls
- Once stopped, the timer can be resumed - simply use the `resume()` method.
```Swift
try! MTimer.resume()
```
- To stop and reset the timer to its initial values, use the `reset()` method.
```Swift
MTimer.reset()
```
### 6. Displaying the current time as String
You can convert the current MTime to String by calling the `toString()` method. Use the `formatter` parameter to customise the output.
```Swift
currentTime.toString {
$0.unitsStyle = .full
$0.allowedUnits = [.hour, .minute]
return $0
}
```
### 7. Creating more timer instances
Create a new instance of the timer and assign it to a new variable. Use the above functions directly with it
```Swift
let newTimer = MTimer.createNewInstance()
try! newTimer
.publish(every: 1, currentTime: $currentTime)
.start()
newTimer.stop()
```
# Try our demo
See for yourself how does it work by cloning [project][Demo] we created
# License
Timer is released under the MIT license. See [LICENSE][License] for details.
# Our other open source SwiftUI libraries
[PopupView] - The most powerful popup library that allows you to present any popup
[NavigationView] - Easier and cleaner way of navigating through your app
[CalendarView] - Create your own calendar object in no time
[GridView] - Lay out your data with no effort
[CameraView] - The most powerful CameraController. Designed for SwiftUI
[MIT]: https://en.wikipedia.org/wiki/MIT_License
[SPM]: https://www.swift.org/package-manager
[cocoapods]: https://cocoapods.org/
[generate_cocoapods]: https://github.com/square/cocoapods-generate
[Demo]: https://github.com/Mijick/Timer-Demo
[License]: https://github.com/Mijick/Timer/blob/main/LICENSE
[PopupView]: https://github.com/Mijick/PopupView
[NavigationView]: https://github.com/Mijick/NavigationView
[CalendarView]: https://github.com/Mijick/CalendarView
[GridView]: https://github.com/Mijick/GridView
[CameraView]: https://github.com/Mijick/CameraView