Files
Stephen Celis 149fdf9c20 Use SPI docs instead of self-hosted (#3791)
* Use SPI docs instead of self-hosted

Fixes #3785.

* wip
2025-10-08 09:28:11 -07:00

109 lines
5.9 KiB
Swift

import SwiftUI
extension View {
/// Presents a sheet using the given store as a data source for the sheet's content.
///
/// > This is a Composable Architecture-friendly version of SwiftUI's `sheet` view modifier.
///
/// - Parameters:
/// - store: A store that is focused on ``PresentationState`` and ``PresentationAction`` for
/// a modal. When `store`'s state is non-`nil`, the system passes a store of unwrapped `State`
/// and `Action` to the modifier's closure. You use this store to power the content in a sheet
/// you create that the system displays to the user. If `store`'s state is `nil`-ed out, the
/// system dismisses the currently displayed sheet.
/// - onDismiss: The closure to execute when dismissing the modal view.
/// - content: A closure returning the content of the modal view.
@available(
iOS, deprecated: 9999,
message:
"Pass a binding of a store to 'sheet(item:)' instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.7#Replacing-navigation-view-modifiers-with-SwiftUI-modifiers]"
)
@available(
macOS, deprecated: 9999,
message:
"Pass a binding of a store to 'sheet(item:)' instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.7#Replacing-navigation-view-modifiers-with-SwiftUI-modifiers]"
)
@available(
tvOS, deprecated: 9999,
message:
"Pass a binding of a store to 'sheet(item:)' instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.7#Replacing-navigation-view-modifiers-with-SwiftUI-modifiers]"
)
@available(
watchOS, deprecated: 9999,
message:
"Pass a binding of a store to 'sheet(item:)' instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.7#Replacing-navigation-view-modifiers-with-SwiftUI-modifiers]"
)
#if swift(<5.10)
@MainActor(unsafe)
#else
@preconcurrency@MainActor
#endif
public func sheet<State, Action, Content: View>(
store: Store<PresentationState<State>, PresentationAction<Action>>,
onDismiss: (() -> Void)? = nil,
@ViewBuilder content: @escaping (_ store: Store<State, Action>) -> Content
) -> some View {
self.presentation(store: store) { `self`, $item, destination in
self.sheet(item: $item, onDismiss: onDismiss) { _ in
destination(content)
}
}
}
/// Presents a sheet using the given store as a data source for the sheet's content.
///
/// > This is a Composable Architecture-friendly version of SwiftUI's `sheet` view modifier.
///
/// - Parameters:
/// - store: A store that is focused on ``PresentationState`` and ``PresentationAction`` for
/// a modal. When `store`'s state is non-`nil`, the system passes a store of unwrapped `State`
/// and `Action` to the modifier's closure. You use this store to power the content in a sheet
/// you create that the system displays to the user. If `store`'s state is `nil`-ed out, the
/// system dismisses the currently displayed sheet.
/// - toDestinationState: A transformation to extract modal state from the presentation state.
/// - fromDestinationAction: A transformation to embed modal actions into the presentation
/// action.
/// - onDismiss: The closure to execute when dismissing the modal view.
/// - content: A closure returning the content of the modal view.
@available(
iOS, deprecated: 9999,
message:
"Further scope the store into the 'state' and 'action' cases, instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.5#Enum-driven-navigation-APIs"
)
@available(
macOS, deprecated: 9999,
message:
"Further scope the store into the 'state' and 'action' cases, instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.5#Enum-driven-navigation-APIs"
)
@available(
tvOS, deprecated: 9999,
message:
"Further scope the store into the 'state' and 'action' cases, instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.5#Enum-driven-navigation-APIs"
)
@available(
watchOS, deprecated: 9999,
message:
"Further scope the store into the 'state' and 'action' cases, instead. For more information, see the following article: https://swiftpackageindex.com/pointfreeco/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.5#Enum-driven-navigation-APIs"
)
#if swift(<5.10)
@MainActor(unsafe)
#else
@preconcurrency@MainActor
#endif
public func sheet<State, Action, DestinationState, DestinationAction, Content: View>(
store: Store<PresentationState<State>, PresentationAction<Action>>,
state toDestinationState: @escaping (_ state: State) -> DestinationState?,
action fromDestinationAction: @escaping (_ destinationAction: DestinationAction) -> Action,
onDismiss: (() -> Void)? = nil,
@ViewBuilder content: @escaping (_ store: Store<DestinationState, DestinationAction>) -> Content
) -> some View {
self.presentation(
store: store, state: toDestinationState, action: fromDestinationAction
) { `self`, $item, destination in
self.sheet(item: $item, onDismiss: onDismiss) { _ in
destination(content)
}
}
}
}