Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathantannar4/Transmission
Bridges UIKit presentation APIs to a SwiftUI API so you can use presentation controllers, interactive transitions and more.
https://github.com/nathantannar4/Transmission
Last synced: 3 months ago
JSON representation
Bridges UIKit presentation APIs to a SwiftUI API so you can use presentation controllers, interactive transitions and more.
- Host: GitHub
- URL: https://github.com/nathantannar4/Transmission
- Owner: nathantannar4
- License: bsd-2-clause
- Created: 2022-11-29T02:38:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T17:58:35.000Z (3 months ago)
- Last Synced: 2024-08-03T19:05:15.150Z (3 months ago)
- Language: Swift
- Size: 23.2 MB
- Stars: 354
- Watchers: 9
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Transmission
`Transmission` aims to improve SwiftUI view presentations and transitions. It does this by bridging UIKit presentation APIs to a SwiftUI API so you can use presentation controllers, interactive transitions and more.
> Built using [Engine](https://github.com/nathantannar4/Engine)
## See Also
- [Turbocharger](https://github.com/nathantannar4/Turbocharger)
- [Ignition](https://github.com/nathantannar4/Ignition)
## Preview
## Requirements
- Deployment target: iOS 13.0, macOS 10.15, tvOS 13.0, or watchOS 6.0
- Xcode 15+
## Installation
### Xcode Projects
Select `File` -> `Swift Packages` -> `Add Package Dependency` and enter `https://github.com/nathantannar4/Transmission`.
### Swift Package Manager Projects
You can add `Transmission` as a package dependency in your `Package.swift` file:
```swift
let package = Package(
//...
dependencies: [
.package(url: "https://github.com/nathantannar4/Transmission"),
],
targets: [
.target(
name: "YourPackageTarget",
dependencies: [
.product(name: "Transmission", package: "Transmission"),
],
//...
),
//...
],
//...
)
```
## Introduction to Transmission
For some sample code to get started with `Transmission`, build and run the included "Example" project.
### PresentationLink
```swift
@available(iOS 14.0, *)
public struct PresentationLinkTransition {
public static var `default`: PresentationLinkTransition
public static let sheet: PresentationLinkTransition
public static func sheet(
selected: Binding? = nil,
detents: [SheetTransitionOptions.Detent]
) -> PresentationLinkTransition
public static let currentContext: PresentationLinkTransition
public static let fullscreen: PresentationLinkTransition
public static let popover: PresentationLinkTransition
public static let slide: PresentationLinkTransition
public static let card: PresentationLinkTransition
public static func custom(_ transition: T) -> PresentationLinkTransition
@available(*, deprecated)
public static func custom(_ transition: T) -> PresentationLinkTransition
}
@available(iOS 15.0, *)
extension SheetTransitionOptions.Detent {
/// Creates a large detent.
public static let large: Detent
/// Creates a medium detent.
public static let medium: Detent
/// Creates a detent with an auto-resolved height of the views ideal size.
public static let ideal: Detent
/// Creates a detent with a constant height.
public static func constant(_ identifier: Identifier, height: CGFloat) -> Detent
/// Creates a detent that's height is lazily resolved.
public static func custom(
_ identifier: Identifier,
resolver: @escaping (ResolutionContext) -> CGFloat?
) -> Detent
}
/// A protocol that defines a custom transition for a ``PresentationLinkTransition``
///
/// > Tip: Use ``PresentationController`` or ``InteractivePresentationController``
///
@available(iOS 14.0, *)
public protocol PresentationLinkTransitionRepresentable {
typealias Context = PresentationLinkTransitionRepresentableContext
associatedtype UIPresentationControllerType: UIPresentationController
/// The presentation controller to use for the transition.
func makeUIPresentationController(
presented: UIViewController,
presenting: UIViewController?,
context: Context
) -> UIPresentationControllerType
func updateUIPresentationController(
presentationController: UIPresentationControllerType,
context: Context
)
}
@available(iOS 14.0, *)
@frozen
public struct PresentationCoordinator {
public var isPresented: Bool
@inlinable
public func dismiss(animation: Animation? = .default)
@inlinable
public func dismiss(transaction: Transaction)
}
@available(iOS 14.0, *)
extension EnvironmentValues {
public var presentationCoordinator: PresentationCoordinator { get }
}
/// A button that presents a destination view in a new `UIViewController`.
///
/// The destination view is presented with the provided `transition`.
/// By default, the ``PresentationLinkTransition/default`` transition is used.
///
/// > Tip: You can implement custom transitions with a `UIPresentationController` and/or
/// `UIViewControllerInteractiveTransitioning` with the ``PresentationLinkTransition/custom(_:)``
/// transition.
///
@available(iOS 14.0, *)
@frozen
public struct PresentationLink<
Label: View,
Destination: View
>: View {
public init(
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
public init(
transition: PresentationLinkTransition = .default,
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
public init(
isPresented: Binding,
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
public init(
transition: PresentationLinkTransition,
isPresented: Binding,
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
}
@available(iOS 14.0, *)
extension PresentationLink {
public init(
destination: @escaping () -> ViewController,
@ViewBuilder label: () -> Label
)
public init(
transition: PresentationLinkTransition,
destination: @escaping () -> ViewController,
@ViewBuilder label: () -> Label
)
public init(
isPresented: Binding,
destination: @escaping () -> ViewController,
@ViewBuilder label: () -> Label
)
public init(
transition: PresentationLinkTransition,
isPresented: Binding,
destination: @escaping () -> ViewController,
@ViewBuilder label: () -> Label
)
}
@available(iOS 14.0, *)
extension PresentationLinkModifier {
public init(
transition: PresentationLinkTransition = .default,
isPresented: Binding,
@ViewBuilder destination: () -> Destination
)
}
@available(iOS 14.0, *)
extension View {
/// A modifier that presents a destination view in a new `UIViewController`.
public func presentation(
transition: PresentationLinkTransition = .default,
isPresented: Binding,
@ViewBuilder destination: () -> Destination
) -> some View
/// A modifier that presents a destination view in a new `UIViewController`.
public func presentation(
_ value: Binding,
transition: PresentationLinkTransition = .default,
@ViewBuilder destination: (Binding) -> Destination
) -> some View
}
```
### TransitionReader
```swift
/// A container view that defines its content as a function of its hosting view's
/// `UIViewControllerTransitionCoordinator` transition progress.
///
/// > Tip: Use a ``TransitionReader`` to build interactive presentation and dismissal
/// transitions
///
public struct TransitionReader: View {
public struct Proxy {
/// The progress state of the transition from 0 to 1 where 1 is fully presented
public var progress: CGFloat
}
public init(@ViewBuilder content: @escaping (Proxy) -> Content)
}
```
### StatusBar Style/Hidden
```swift
@available(iOS 14.0, *)
extension View {
/// Sets the preferred status bar style of the hosting views `UIViewController`
public func preferredStatusBarStyle(_ style: UIStatusBarStyle) -> some View
/// Sets the preferred status bar visibility of the hosting views `UIViewController`
public func prefersStatusBarHidden(_ isHidden: Bool = true) -> some View
}
```
### WindowLink
```swift
@available(iOS 14.0, *)
public struct WindowLinkLevel {
public static var `default`: WindowLinkLevel
public static var overlay: WindowLinkLevel
public static var background: WindowLinkLevel
public static let alert: WindowLinkLevel
public static func custom(_ level: CGFloat) -> WindowLinkLevel
}
@available(iOS 14.0, *)
public struct WindowLinkTransition {
public static let identity: WindowLinkTransition
public static let opacity: WindowLinkTransition
public static func move(edge: Edge) -> WindowLinkTransition
public static func scale(_ multiplier: CGFloat) -> WindowLinkTransition
}
extension WindowLinkTransition {
public func combined(with other: WindowLinkTransition) -> WindowLinkTransition
}
/// A button that presents a destination view in a new `UIWindow`.
@available(iOS 14.0, *)
@frozen
public struct WindowLink<
Label: View,
Destination: View
>: View {
public init(
level: WindowLinkLevel = .default,
transition: WindowLinkTransition = .opacity,
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
public init(
level: WindowLinkLevel = .default,
transition: WindowLinkTransition = .opacity,
isPresented: Binding,
@ViewBuilder destination: () -> Destination,
@ViewBuilder label: () -> Label
)
}
@available(iOS 14.0, *)
extension View {
/// A modifier that presents a destination view in a new `UIWindow`
public func window(
level: WindowLinkLevel = .default,
transition: WindowLinkTransition = .opacity,
isPresented: Binding,
@ViewBuilder destination: () -> Destination
) -> some View
/// A modifier that presents a destination view in a new `UIWindow`
public func window(
_ value: Binding,
level: WindowLinkLevel = .default,
transition: WindowLinkTransition = .opacity,
@ViewBuilder destination: (Binding) -> D
) -> some View
}
```
### ShareSheetLink
```swift
/// A protocol that defines an interface for creating activities for a `UIActivityViewController`
@available(iOS 14.0, *)
public protocol ShareSheetItemProvider {
func makeUIActivityItemSource(context: Context) -> UIActivityItemSource
func makeUIActivity(context: Context) -> UIActivity?
typealias Context = ShareSheetItemProviderContext
}
/// A share sheet provider for a string.
@available(iOS 14.0, *)
extension String: ShareSheetItemProvider {
public func makeUIActivityItemSource(context: Context) -> UIActivityItemSource
}
/// A share sheet provider for a url.
@available(iOS 14.0, *)
extension URL: ShareSheetItemProvider {
public func makeUIActivityItemSource(context: Context) -> UIActivityItemSource
}
/// A share sheet provider for generating an image from a view.
@available(iOS 14.0, *)
@frozen
public struct SnapshotItemProvider: ShareSheetItemProvider {
public init(label: LocalizedStringKey, content: Content)
}
/// A button that presents a `UIActivityViewController`
@available(iOS 14.0, *)
@frozen
public struct ShareSheetLink<
Label: View
>: View {
public init(
items: [ShareSheetItemProvider],
action: ((Result) -> Void)? = nil,
@ViewBuilder label: () -> Label
)
public init(
items: [ShareSheetItemProvider],
action: ((Result) -> Void)? = nil,
isPresented: Binding,
@ViewBuilder label: () -> Label
)
}
@available(iOS 14.0, *)
extension View {
/// A modifier that presents a `UIActivityViewController`
public func share(
items: [ShareSheetItemProvider],
isPresented: Binding,
action: ((Result) -> Void)? = nil
) -> some View
}
/// A modifier that presents a `UIActivityViewController`
@available(iOS 14.0, *)
@frozen
public struct ShareSheetLinkModifier: ViewModifier {
public init(
items: [ShareSheetItemProvider],
action: ((Result) -> Void)? = nil,
isPresented: Binding
)
}
```
### QuickLookPreviewLink
```swift
/// A quick look preview provider.
@available(iOS 14.0, *)
@frozen
public struct QuickLookPreviewItem: Equatable {
public var url: URL
public var label: Text?
public init(url: URL, label: Text? = nil)
}
/// A button that presents a `QLPreviewController`
@available(iOS 14.0, *)
@frozen
public struct QuickLookPreviewLink<
Label: View
>: View {
public init(
items: [QuickLookPreviewItem],
transition: QuickLookPreviewTransition = .default,
@ViewBuilder label: () -> Label
)
public init(
items: [QuickLookPreviewItem],
transition: QuickLookPreviewTransition = .default,
isPresented: Binding,
@ViewBuilder label: () -> Label
)
public init(
url: URL,
transition: QuickLookPreviewTransition = .default,
@ViewBuilder label: () -> Label
)
}
@available(iOS 14.0, *)
extension View {
/// A modifier that presents a `QLPreviewController`
public func quickLookPreview(
items: [QuickLookPreviewItem],
transition: QuickLookPreviewTransition = .default,
isPresented: Binding
) -> some View
/// A modifier that presents a `QLPreviewController`
public func quickLookPreview(
url: URL,
transition: QuickLookPreviewTransition = .default,
isPresented: Binding
) -> some View
}
/// A modifier that presents a `QLPreviewController`
@available(iOS 14.0, *)
@frozen
public struct QuickLookPreviewLinkModifier: ViewModifier {
public init(
items: [QuickLookPreviewItem],
transition: QuickLookPreviewTransition = .default,
isPresented: Binding
)
}
```
## License
Distributed under the BSD 2-Clause License. See ``LICENSE.md`` for more information.