Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaps80/SwiftUIBackports
A collection of SwiftUI backports for iOS, macOS, tvOS and watchOS
https://github.com/shaps80/SwiftUIBackports
backport ios macos modal photopicker presentation propertywrapper sharesheet swift swiftui textview tvos watchos
Last synced: about 2 months ago
JSON representation
A collection of SwiftUI backports for iOS, macOS, tvOS and watchOS
- Host: GitHub
- URL: https://github.com/shaps80/SwiftUIBackports
- Owner: shaps80
- License: mit
- Created: 2022-06-24T22:10:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T19:15:33.000Z (9 months ago)
- Last Synced: 2024-11-21T13:12:29.276Z (2 months ago)
- Topics: backport, ios, macos, modal, photopicker, presentation, propertywrapper, sharesheet, swift, swiftui, textview, tvos, watchos
- Language: Swift
- Homepage:
- Size: 18.1 MB
- Stars: 966
- Watchers: 12
- Forks: 61
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/shaps80/SwiftUIBackports)
# SwiftUI Backports
Introducing a collection of SwiftUI backports to make your iOS development easier.
Many backports support iOS 13+ but where UIKIt features were introduced in later versions, the same will be applicable to these backports, to keep parity with UIKit.
In some cases, I've also included additional APIs that bring more features to your SwiftUI development.
> Note, **all** backports will be API-matching to Apple's official APIs, any additional features will be provided separately.
All backports are fully documented, in most cases using Apple's own documentation for consistency. Please refer to the header docs or Apple's original documentation for more details.
There is also a [Demo project](https://github.com/shaps80/SwiftUIBackportsDemo) available where you can see full demonstrations of all backports and additional features, including reference code to help you get started.
> Lastly, I hope this repo also serves as a great resource for _how_ you can backport effectively with minimal hacks 👍
## Documentation
Full [documentation](https://shaps80.github.io/SwiftUIBackports/documentation/SwiftUIBackports) can be found [here](https://shaps80.github.io/SwiftUIBackports/documentation/SwiftUIBackports).
## Sponsor
Building useful libraries like these, takes time away from my family. I build these tools in my spare time because I feel its important to give back to the community. Please consider [Sponsoring](https://github.com/sponsors/shaps80) me as it helps keep me working on useful libraries like these 😬
You can also give me a follow and a 'thanks' anytime.
[](http://twitter.com/shaps)
## Usage
The library adopts a backport design by [Dave DeLong](https://davedelong.com/blog/2021/10/09/simplifying-backwards-compatibility-in-swift/) that makes use of a single type to improve discoverability and maintainability when the time comes to remove your backport implementations, in favour of official APIs.
Backports of pure types, can easily be discovered under the `Backport` namespace. Similarly, modifiers are discoverable under the `.backport` namespace.
> Unfortunately `Environment` backports cannot be access this way, in those cases the Apple API values will be prefixed with `backport` to simplify discovery.
Types:
```swift
@Backport.AppStorage("filter-enabled")
private var filterEnabled: Bool = false
```
Modifier:
```swift
Button("Show Prompt") {
showPrompt = true
}
.sheet(isPresented: $showPrompt) {
Prompt()
.backport.presentationDetents([.medium, .large])
}
```
Environment:
```swift
@Environment(\.backportRefresh) private var refreshAction
```
## Backports
**SwiftUI**
- `AsyncImage`
- `AppStorage`
- `background` – ViewBuilder API
- `DismissAction`
- `DynamicTypeSize`
– `Label`
– `LabeledContent`
- `NavigationDestination` – uses a standard NavigationView
- `navigationTitle` – newer API
- `overlay` – ViewBuilder API
- `onChange`
- `openURL`
- `ProgressView`
- `presentationDetents`
- `presentationDragIndicator`
- `quicklookPreview`
- `requestReview`
- `Refreshable` – includes pull-to-refresh
- `ScaledMetric`
- `ShareLink`
- `StateObject`
- `scrollDisabled`
- `scrollDismissesKeyboard`
- `scrollIndicators`
- `Section(_ header:)`
- `task` – async/await modifier
**UIKit**
- `UIHostingConfiguration` – simplifies embedding SwiftUI in `UICollectionViewCell` and `UITableViewCell`
## Extras
**Modal Presentations**
Adding this to your presented view, you can use the provided closure to present an `ActionSheet` to a user when they attempt to dismiss interactively. You can also use this to disable interactive dismissals entirely.
```swift
presentation(isModal: true) { /* attempt */ }
```
**FittingGeometryReader**
A custom `GeometryReader` implementation that correctly auto-sizes itself to its content. This is useful in many cases where you need a `GeometryReader` but don't want it to implicitly take up its parent View's bounds.
**FittingScrollView**
A custom `ScrollView` that respects `Spacer`'s when the content is not scrollable. This is useful when you need to place a view at the edges of your scrollview while its content is small enough to not require scrolling. Another great use case is vertically centered content that becomes `top` aligned once the content requires scrolling.
## Installation
You can install manually (by copying the files in the `Sources` directory) or using Swift Package Manager (**preferred**)
To install using Swift Package Manager, add this to the `dependencies` section of your `Package.swift` file:
`.package(url: "https://github.com/shaps80/SwiftUIBackports.git", .upToNextMajor(from: "2.0.0"))`