https://github.com/ipedro/swift-choosable
Choosable
https://github.com/ipedro/swift-choosable
Last synced: 10 months ago
JSON representation
Choosable
- Host: GitHub
- URL: https://github.com/ipedro/swift-choosable
- Owner: ipedro
- License: mit
- Created: 2023-11-04T10:00:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-11T04:48:19.000Z (over 2 years ago)
- Last Synced: 2025-06-18T03:02:40.698Z (12 months ago)
- Language: Swift
- Homepage: https://ipedro.github.io/swift-choosable/
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Choosable
[](https://github.com/ipedro/swift-choosable/blob/main/LICENSE)
`Choosable` is a Swift protocol designed to empower objects with context-aware capabilities, allowing them to respond dynamically to conditions. By adopting `Choosable`, any Swift type can elegantly choose between itself and an alternative based on the truth value of given conditions.
This flexibility opens the door to cleaner, more readable conditional logic throughout your Swift projects—from feature flagging to adaptive UI elements, `Choosable` can streamline the way you handle binary decisions.
## Features
- 🔄 **Toggle Behavior**: Seamlessly switch between values or states.
- 🔍 **Context-Aware**: Make decisions based on runtime conditions.
- ✅ **Type-agnostic**: Works with any type, including custom types.
- 📦 **No External Dependencies**: Easy to integrate into any project.
## Installation
### Swift Package Manager
You can add `Choosable` to your project via Swift Package Manager, by adding the following to your `Package.swift` file in the `dependencies` array:
```swift
.package(url: "https://github.com/ipedro/swift-choosable.git", .upToNextMajor(from: "1.0.0"))
```
## Usage
Integrating `Choosable` into your types is straightforward:
```swift
extension MyType: Choosable {}
```
Once conformed, the `or(_:when:)` method is available to elegantly handle conditional logic:
```swift
let item = myDefaultItem.or(anotherItem, when: someCondition)
```
### Examples
#### Primitives
```swift
let discount = 0.0.or(15.0, when: isHolidaySeason) // Returns 15.0 if `isHolidaySeason` is true
```
#### Optionals
```swift
let user = currentUser.or(defaultUser, when: currentUser == nil) // Returns `defaultUser` if `currentUser` is nil
```
#### Collections
```swift
let data = cachedData.or(freshData, when: isCacheExpired) // Returns `freshData` if `isCacheExpired` is true
```
#### Custom Types
```swift
struct FeatureFlag: Choosable {
let isEnabled: Bool
}
let featureA = FeatureFlag(isEnabled: true)
let featureB = FeatureFlag(isEnabled: false)
let featureC = FeatureFlag(isEnabled: false)
// Given a condition, choose `featureA`, `featureB` or `featureC`.
// In this case, `isEnabled` flag is true, so `featureA` will be chosen.
let activeFeature = featureA
.or(featureB, when: featureA.isEnabled)
.or(featureC, when: featureB.isEnabled)
```
#### Adaptive UI Elements
```swift
import SwiftUI
struct AdaptiveTextColor: View {
@State
private var isSelected: Bool = false
@Environment(\.isEnabled)
private var isEnabled
var body: some View {
Text("Hello, Choosable!")
.foregroundColor(Color.black
.or(Color.white, when: isSelected)
.or(Color.gray, when: !isEnabled)
)
.background { Color.red }
}
}
struct AdaptiveFontStyle: View {
@State
private var isHorizontal: Bool = false
var body: some View {
Text("Dynamic Font Size")
.font(.body.or(.largeTitle, when: isHorizontal))
}
}
```
## License
`Choosable` is released under the MIT license. See [LICENSE](LICENSE) for details.