Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/crelies/tvdatepicker

The missing SwiftUI DatePicker view for tvOS
https://github.com/crelies/tvdatepicker

datepicker swift swiftui tvos

Last synced: about 1 month ago
JSON representation

The missing SwiftUI DatePicker view for tvOS

Host: GitHub
URL: https://github.com/crelies/tvdatepicker
Owner: crelies
License: mit
Created: 2020-12-20T19:17:22.000Z (about 4 years ago)
Default Branch: dev
Last Pushed: 2023-05-26T16:01:41.000Z (over 1 year ago)
Last Synced: 2024-11-23T15:17:00.556Z (2 months ago)
Topics: datepicker, swift, swiftui, tvos
Language: Swift
Homepage:
Size: 6.83 MB
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 📅 TVDatePicker

A `SwiftUI` `DatePicker` view for `tvOS`

[![Swift 5.3](https://img.shields.io/badge/swift-5.3-green.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
[![Platforms](https://img.shields.io/badge/platform-tvOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com)
[![Current Version](https://img.shields.io/github/v/tag/crelies/TVDatePicker?longCache=true&style=flat-square)](https://github.com/crelies/TVDatePicker)
[![License](https://img.shields.io/badge/license-MIT-lightgrey.svg?longCache=true&style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)

## ❤️ Motivation

Currently there is no native `SwiftUI` `DatePicker` for `tvOS`. That's why I created this Swift package to fill the hole 😊
The `API` mimics the one of the native `SwiftUI` `DatePicker` available for `iOS`, `macOS` and `macCatalyst`.

## ℹ️ Installation

Just add this Swift package as a dependency to your `Package.swift`:

```swift
.package(url: "https://github.com/crelies/TVDatePicker.git", from: "0.1.0")
```

## 🧭 Usage

The following code snippet shows how to use the `DatePicker` `view` in your `tvOS` application:

```swift
TVDatePicker(
_ titleKey: LocalizedStringKey,
selection: Binding,
minimumDate: Date,
displayedComponents: Components = .all,
calendar: Calendar = .current,
dateFormatter: DateFormatter = DateFormatters.defaultFormatter,
label: () -> Label
) // Available when Label conforms to View.
```

At first the view appears as a button with a horizontal stack containing the specified `label`, a `Text` view representing the current `selection` date string and a `disclosure indicator` `Image` view. If you press the button a sheet with the actual date picker view appears. The following screenshot is an example:

Screenshot of a date picker view usage example

## 📖 Implementation

The `DatePicker` view is implemented by using multiple `Picker`s with the `SegmentedPickerStyle` inside a `List` / `VStack`.
Each `Picker` represents a date component like `year`, `month` or `date`. Due to issues with the focus engine the implementation slightly differs for the supported tvOS versions `13.0`, `14.0` and > `14.0`. But I think that you can ignore this detail in most cases.

## 🔒 Limitations

- ⚠️ The `DatePicker` was only tested with the `Gregorian calendar`.
- The `year` component displays only `10` years at a time (`selected year +/- 5 years` with respect to the year of the specified `minimum date`).
- ⚠️ Currently only the `year` component respects the `minimum date`. On the contrary `all months of a year` and `all days of a month` are visible at all time.
- Currently the `hourAndMinute` component always displays all `24 hours` of a day.
- The `hourAndMinute` component supports only steps by five for the `minute`.