Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ViacomInc/TVOSPicker
This swift package provides a component that is missing from UIKit on tvOS - a picker view. It also provides a simple Date Picker built on top of the base TVOSPickerView component.
https://github.com/ViacomInc/TVOSPicker
datepicker pickerview tvos
Last synced: 2 months ago
JSON representation
This swift package provides a component that is missing from UIKit on tvOS - a picker view. It also provides a simple Date Picker built on top of the base TVOSPickerView component.
- Host: GitHub
- URL: https://github.com/ViacomInc/TVOSPicker
- Owner: ViacomInc
- License: apache-2.0
- Created: 2023-04-25T18:28:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-15T11:59:20.000Z (5 months ago)
- Last Synced: 2024-07-15T14:07:00.554Z (5 months ago)
- Topics: datepicker, pickerview, tvos
- Language: Swift
- Homepage:
- Size: 53.7 KB
- Stars: 33
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TVOSPicker
This package provides a component that is missing from UIKit on tvOS - a picker view. The API and behaviour of the `TVOSPickerView` is heavily inspired by iOS `UIPickerView`.
This package also provides a simple date picker built on top of the base TVOSPickerView component. Currently, it only supports Gregorian calendar.
https://github.com/ViacomInc/TVOSPicker/assets/126462761/7fbea5d4-00ec-4d0a-8103-af45f1e087ce
## Requirements
- Swift 5.7
- tvOS 13+
## Installation
### Swift Package Manager
Add to your `Package.swift`:
```
dependencies: [
.package(url: "https://github.com/ViacomInc/TVOSPicker.git", .upToNextMajor(from: "0.1.0"))
]
```
## Usage
You can find a few usage examples in `TVOSPickerViewExamples` project in `Examples` directory.
### TVOSPickerView
To use `TVOSPickerView`, add it to the view hierarchy and set the `delegate` property to an object conforming to `TVOSPickerViewDelegate` protocol. Delegate controls how many components are displayed (columns), how many rows are there in each component and what string to display in each row. Custom row views are not supported currently. Optionally, delegate can customize width of each column (by default, columns are of equal width) as well as accessibility labels for rows.
```swift
import TVOSPicker
...
// ViewController viewDidLoad
let picker = TVOSPickerView(
style: .default, // pass custom style here if needed
delegate: self
)
view.addSubview(picker)
... // setup frames/constraints
// to reload all components
picker.reloadData()
// to reload specific components
picker.reloadComponents([0, 2, 4])
// OR
picker.reloadComponent(1)
// ViewController TVOSPickerViewDelegate conformance
extension ViewController: TVOSPickerViewDelegate {
func numberOfComponents(in pickerView: TVOSPickerView) -> Int {
// number of components (columns)
}
func pickerView(_ pickerView: TVOSPickerView, numberOfRowsInComponent component: Int) -> Int {
// number of rows in each component
}
func pickerView(_ pickerView: TVOSPickerView, titleForRow row: Int, inComponent component: Int) -> String? {
// string to display in each row
}
func pickerView(_ pickerView: TVOSPickerView, didSelectRow row: Int, inComponent component: Int) {
// update state with the newly selected row
}
func indexOfSelectedRow(inComponent component: Int, ofPickerView pickerView: TVOSPickerView) -> Int? {
// provide an index of selected row - used as initially focused index as well as after each reloadData
}
}
```
### TVOSDatePickerView
`TVOSDatePickerView` is a view built on top of `TVOSPickerView`. It stores the picker delegate object and requires it to be a `GregorianCalendarDatePickerDelegate`. This delegate provides a default implementation for a picker with 3 components: day, month and year. Initializer parameters allow to configure order of components, locale, supported date ranges, initial date as well as custom formatters for days, months and years.
```swift
import TVOSPicker
...
// ViewController viewDidLoad
let picker = TVOSDatePickerView(
delegate: GregorianCalendarDatePickerDelegate( // delegate supporting Gregorian calendar is provided with the package
order: .dayMonthYear, // customize order of components
locale: Locale.autoupdatingCurrent,
minYear: 1950,
initialDate: Date()
)
)
picker.style = ... // by default TVOSDatePickerView uses .datePicker style, this can be overriden here
view.addSubview(picker)
... // setup frames/constraints
// to retrieve selected date
print(picker.date)
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## License
TVOSPicker is released under the Apache 2.0 license. [See LICENSE](LICENSE) for details.