ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-03 06:02:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace FilePreviewScreen with InteractiveQuickLook. (#1187)

Browse Source 
* Replace FilePreviewScreen with InteractiveQuickLook.

- Allows full screen presentation.
- Allows dismiss gesture to work.
- Presentation looks much better on macOS.
This commit is contained in:
Doug
2023-06-28 15:32:16 +01:00
committed by GitHub
parent 908b368680
commit afbb0a8260
14 changed files with 147 additions and 363 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/FlowCoordinators/RoomFlowCoordinator.swift
-31
View File
@@ -119,11 +119,6 @@ class RoomFlowCoordinator: FlowCoordinatorProtocol {
case (.dismissRoomMemberDetails, .roomMemberDetails(let roomID, _)):
return .room(roomID: roomID)
case (.presentMediaViewer(let file, let title), .room(let roomID)):
return .mediaViewer(roomID: roomID, file: file, title: title)
case (.dismissMediaViewer, .mediaViewer(let roomID, _, _)):
return .room(roomID: roomID)
case (.presentReportContent(let itemID, let senderID), .room(let roomID)):
return .reportContent(roomID: roomID, itemID: itemID, senderID: senderID)
case (.dismissReportContent, .reportContent(let roomID, _, _)):
@@ -185,11 +180,6 @@ class RoomFlowCoordinator: FlowCoordinatorProtocol {
case (.roomDetails, .dismissRoom, .initial):
dismissRoom(animated: animated)
case (.room, .presentMediaViewer, .mediaViewer(_, let file, let title)):
presentMediaViewer(file, title: title)
case (.mediaViewer, .dismissMediaViewer, .room):
break
case (.room, .presentReportContent, .reportContent(_, let itemID, let senderID)):
presentReportContent(for: itemID, from: senderID)
case (.reportContent, .dismissReportContent, .room):
@@ -308,8 +298,6 @@ class RoomFlowCoordinator: FlowCoordinatorProtocol {
switch action {
case .presentRoomDetails:
stateMachine.tryEvent(.presentRoomDetails(roomID: roomID))
case .presentMediaViewer(let file, let title):
stateMachine.tryEvent(.presentMediaViewer(file: file, title: title))
case .presentReportContent(let itemID, let senderID):
stateMachine.tryEvent(.presentReportContent(itemID: itemID, senderID: senderID))
case .presentMediaUploadPicker(let source):
@@ -412,21 +400,6 @@ class RoomFlowCoordinator: FlowCoordinatorProtocol {
}
}
private func presentMediaViewer(_ file: MediaFileHandleProxy, title: String?) {
let params = FilePreviewScreenCoordinatorParameters(mediaFile: file, title: title)
let coordinator = FilePreviewScreenCoordinator(parameters: params)
coordinator.callback = { [weak self] action in
switch action {
case .cancel:
self?.navigationStackCoordinator.pop()
}
}
navigationStackCoordinator.push(coordinator) { [weak self] in
self?.stateMachine.tryEvent(.dismissMediaViewer)
}
}
private func presentReportContent(for itemID: String, from senderID: String) {
guard let roomProxy else {
fatalError()
@@ -640,7 +613,6 @@ private extension RoomFlowCoordinator {
enum State: StateType {
case initial
case room(roomID: String)
case mediaViewer(roomID: String, file: MediaFileHandleProxy, title: String?)
case reportContent(roomID: String, itemID: String, senderID: String)
case roomDetails(roomID: String, isRoot: Bool)
case mediaUploadPicker(roomID: String, source: MediaPickerScreenSource)
@@ -660,9 +632,6 @@ private extension RoomFlowCoordinator {
case presentRoom(roomID: String)
case dismissRoom
case presentMediaViewer(file: MediaFileHandleProxy, title: String?)
case dismissMediaViewer
case presentReportContent(itemID: String, senderID: String)
case dismissReportContent
ElementX/Sources/Screens/FilePreviewScreen/FilePreviewScreenCoordinator.swift
-56
View File
@@ -1,56 +0,0 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import SwiftUI
struct FilePreviewScreenCoordinatorParameters {
let mediaFile: MediaFileHandleProxy
let title: String?
}
enum FilePreviewScreenCoordinatorAction {
case cancel
}
final class FilePreviewScreenCoordinator: CoordinatorProtocol {
private let parameters: FilePreviewScreenCoordinatorParameters
private var viewModel: FilePreviewScreenViewModelProtocol
var callback: ((FilePreviewScreenCoordinatorAction) -> Void)?
init(parameters: FilePreviewScreenCoordinatorParameters) {
self.parameters = parameters
viewModel = FilePreviewScreenViewModel(mediaFile: parameters.mediaFile, title: parameters.title)
}
// MARK: - Public
func start() {
viewModel.callback = { [weak self] action in
guard let self else { return }
switch action {
case .cancel:
self.callback?(.cancel)
}
}
}
func toPresentable() -> AnyView {
AnyView(FilePreviewScreen(context: viewModel.context))
}
}
ElementX/Sources/Screens/FilePreviewScreen/FilePreviewScreenModels.swift
-30
View File
@@ -1,30 +0,0 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
enum FilePreviewScreenViewModelAction {
case cancel
}
struct FilePreviewScreenViewState: BindableState {
let mediaFile: MediaFileHandleProxy
let title: String?
}
enum FilePreviewScreenViewAction {
case cancel
}
ElementX/Sources/Screens/FilePreviewScreen/FilePreviewScreenViewModel.swift
-34
View File
@@ -1,34 +0,0 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import SwiftUI
typealias FilePreviewScreenViewModelType = StateStoreViewModel<FilePreviewScreenViewState, FilePreviewScreenViewAction>
class FilePreviewScreenViewModel: FilePreviewScreenViewModelType, FilePreviewScreenViewModelProtocol {
var callback: ((FilePreviewScreenViewModelAction) -> Void)?
init(mediaFile: MediaFileHandleProxy, title: String? = nil) {
super.init(initialViewState: FilePreviewScreenViewState(mediaFile: mediaFile, title: title))
}
override func process(viewAction: FilePreviewScreenViewAction) {
switch viewAction {
case .cancel:
callback?(.cancel)
}
}
}
ElementX/Sources/Screens/FilePreviewScreen/FilePreviewScreenViewModelProtocol.swift
-23
View File
@@ -1,23 +0,0 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
@MainActor
protocol FilePreviewScreenViewModelProtocol {
var callback: ((FilePreviewScreenViewModelAction) -> Void)? { get set }
var context: FilePreviewScreenViewModelType.Context { get }
}
ElementX/Sources/Screens/FilePreviewScreen/InteractiveQuickLook.swift
+130
View File
@@ -0,0 +1,130 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import QuickLook
import SwiftUI
extension View {
/// Preview a media file using a QuickLook Preview Controller. The preview is interactive with
/// the dismiss gesture working as expected if it was presented from UIKit.
func interactiveQuickLook(item: Binding<MediaPreviewItem?>) -> some View {
modifier(InteractiveQuickLookModifier(item: item))
}
}
private struct InteractiveQuickLookModifier: ViewModifier {
@Binding var item: MediaPreviewItem?
func body(content: Content) -> some View {
content.background {
if let item {
MediaPreviewViewController(previewItem: item) { self.item = nil }
}
}
}
}
private struct MediaPreviewViewController: UIViewControllerRepresentable {
let previewItem: MediaPreviewItem
let onDismiss: () -> Void
func makeUIViewController(context: Context) -> PreviewHostingController {
PreviewHostingController(previewItem: previewItem, onDismiss: onDismiss)
}
func updateUIViewController(_ uiViewController: PreviewHostingController, context: Context) { }
/// A view controller that hosts the QuickLook preview.
///
/// This wrapper somehow allows the preview controller to do presentation/dismissal
/// animations and interactions which don't work if you represent it directly to SwiftUI 🤷‍♂️
class PreviewHostingController: UIViewController, QLPreviewControllerDataSource, QLPreviewControllerDelegate {
let previewItem: MediaPreviewItem
let onDismiss: () -> Void
var previewController: QLPreviewController?
init(previewItem: MediaPreviewItem, onDismiss: @escaping () -> Void) {
self.previewItem = previewItem
self.onDismiss = onDismiss
super.init(nibName: nil, bundle: nil)
}
@available(*, unavailable)
required init?(coder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
override func viewDidLoad() {
view.backgroundColor = .clear
}
override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
guard self.previewController == nil else { return }
let previewController = QLPreviewController()
previewController.dataSource = self
previewController.delegate = self
present(previewController, animated: true)
self.previewController = previewController
}
// MARK: QLPreviewControllerDataSource
func numberOfPreviewItems(in controller: QLPreviewController) -> Int {
1
}
func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> QLPreviewItem {
previewItem
}
// MARK: QLPreviewControllerDelegate
func previewControllerDidDismiss(_ controller: QLPreviewController) {
onDismiss()
}
}
}
/// Wraps a media file and title to be previewed with QuickLook.
class MediaPreviewItem: NSObject, QLPreviewItem {
let file: MediaFileHandleProxy
var previewItemURL: URL? { file.url }
let previewItemTitle: String?
init(file: MediaFileHandleProxy, title: String?) {
self.file = file
previewItemTitle = title
}
}
// MARK: - Previews
struct PreviewView_Previews: PreviewProvider {
static let previewURL = URL(staticString: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf")
static let previewItem = MediaPreviewItem(file: .unmanaged(url: previewURL),
title: "Important Document")
static var previews: some View {
MediaPreviewViewController(previewItem: previewItem) { }
}
}
ElementX/Sources/Screens/FilePreviewScreen/View/FilePreviewScreen.swift
-101
View File
@@ -1,101 +0,0 @@
//
// Copyright 2022 New Vector Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import QuickLook
import SwiftUI
import UIKit
struct FilePreviewScreen: View {
@ObservedObject var context: FilePreviewScreenViewModel.Context
var body: some View {
ZStack(alignment: .leading) {
PreviewView(context: context,
fileURL: context.viewState.mediaFile.url,
title: context.viewState.title)
.ignoresSafeArea(edges: .bottom)
// Drop a random view on top to make QLPreviewController stop
// swallowing all gestures and allow swiping backwards
Rectangle()
.frame(maxWidth: 20.0)
.foregroundColor(.red)
.opacity(0.005)
.ignoresSafeArea()
}
}
}
private struct PreviewView: UIViewControllerRepresentable {
let context: FilePreviewScreenViewModel.Context
let fileURL: URL
let title: String?
func makeUIViewController(context: Context) -> UINavigationController {
let controller = QLPreviewController()
controller.dataSource = context.coordinator
return UINavigationController(rootViewController: controller)
}
func updateUIViewController(_ uiViewController: UINavigationController, context: Context) { }
func makeCoordinator() -> Coordinator {
Coordinator(view: self)
}
class Coordinator: NSObject, QLPreviewControllerDataSource {
let view: PreviewView
init(view: PreviewView) {
self.view = view
}
@objc func done() {
Task { await view.context.send(viewAction: .cancel) }
}
// MARK: - QLPreviewControllerDataSource
func numberOfPreviewItems(in controller: QLPreviewController) -> Int {
1
}
func previewController(_ controller: QLPreviewController, previewItemAt index: Int) -> QLPreviewItem {
PreviewItem(previewItemURL: view.fileURL, previewItemTitle: view.title)
}
}
}
private class PreviewItem: NSObject, QLPreviewItem {
var previewItemURL: URL?
var previewItemTitle: String?
init(previewItemURL: URL?, previewItemTitle: String?) {
self.previewItemURL = previewItemURL
self.previewItemTitle = previewItemTitle
}
}
// MARK: - Previews
struct FilePreviewScreen_Previews: PreviewProvider {
static let viewModel = FilePreviewScreenViewModel(mediaFile: .unmanaged(url: URL(staticString: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf")))
static var previews: some View {
FilePreviewScreen(context: viewModel.context)
}
}
ElementX/Sources/Screens/RoomScreen/RoomScreenCoordinator.swift
-3
View File
@@ -25,7 +25,6 @@ struct RoomScreenCoordinatorParameters {
}
enum RoomScreenCoordinatorAction {
case presentMediaViewer(file: MediaFileHandleProxy, title: String?)
case presentReportContent(itemID: String, senderID: String)
case presentMediaUploadPicker(MediaPickerScreenSource)
case presentMediaUploadPreviewScreen(URL)
@@ -67,8 +66,6 @@ final class RoomScreenCoordinator: CoordinatorProtocol {
switch action {
case .displayRoomDetails:
actionsSubject.send(.presentRoomDetails)
case .displayMediaViewer(let file, let title):
actionsSubject.send(.presentMediaViewer(file: file, title: title))
case .displayEmojiPicker(let itemID):
actionsSubject.send(.presentEmojiPicker(itemID: itemID))
case .displayReportContent(let itemID, let senderID):
ElementX/Sources/Screens/RoomScreen/RoomScreenModels.swift
+3 -1
View File
@@ -20,7 +20,6 @@ import UIKit
enum RoomScreenViewModelAction {
case displayRoomDetails
case displayMediaViewer(file: MediaFileHandleProxy, title: String?)
case displayEmojiPicker(itemID: String)
case displayReportContent(itemID: String, senderID: String)
case displayCameraPicker
@@ -115,6 +114,9 @@ struct RoomScreenViewStateBindings {
}
}
/// A media item that will be previewed with QuickLook.
var mediaPreviewItem: MediaPreviewItem?
/// Information describing the currently displayed alert.
var alertInfo: AlertInfo<RoomScreenErrorType>?
ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift
+1 -1
View File
@@ -220,7 +220,7 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
switch action {
case .displayMediaFile(let file, let title):
callback?(.displayMediaViewer(file: file, title: title))
state.bindings.mediaPreviewItem = MediaPreviewItem(file: file, title: title)
case .none:
break
}
ElementX/Sources/Screens/RoomScreen/View/RoomScreen.swift
+1
View File
@@ -50,6 +50,7 @@ struct RoomScreen: View {
.environmentObject(context)
}
}
.interactiveQuickLook(item: $context.mediaPreviewItem)
.track(screen: .room)
.task(id: context.viewState.roomId) {
// Give a couple of seconds for items to load and to see them.