mirror of
https://github.com/Novaloop-AG/element-x-ios.git
synced 2026-11-03 16:10:20 +00:00
Refactored alert info to not use the soon to be deprecated API (#1084)
* refactored alert info to not use the soon to be deprecated API * missing files and changelog * updated some tests * Update ElementX/Sources/Screens/RoomMemberDetailsScreen/View/RoomMemberDetailsScreen.swift Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com> --------- Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
This commit is contained in:
Mauro
GitHub
@@ -16,12 +16,12 @@
|
||||
|
||||
import SwiftUI
|
||||
|
||||
protocol AlertItem {
|
||||
protocol AlertProtocol {
|
||||
var title: String { get }
|
||||
}
|
||||
|
||||
extension View {
|
||||
func alert<Item, Actions, Message>(item: Binding<Item?>, @ViewBuilder actions: (Item) -> Actions, @ViewBuilder message: (Item) -> Message) -> some View where Item: AlertItem, Actions: View, Message: View {
|
||||
func alert<Item, Actions, Message>(item: Binding<Item?>, @ViewBuilder actions: (Item) -> Actions, @ViewBuilder message: (Item) -> Message) -> some View where Item: AlertProtocol, Actions: View, Message: View {
|
||||
let binding = Binding<Bool>(get: {
|
||||
item.wrappedValue != nil
|
||||
}, set: { newValue in
|
||||
@@ -32,7 +32,7 @@ extension View {
|
||||
return alert(item.wrappedValue?.title ?? "", isPresented: binding, presenting: item.wrappedValue, actions: actions, message: message)
|
||||
}
|
||||
|
||||
func alert<Item, Actions>(item: Binding<Item?>, @ViewBuilder actions: (Item) -> Actions) -> some View where Item: AlertItem, Actions: View {
|
||||
func alert<Item, Actions>(item: Binding<Item?>, @ViewBuilder actions: (Item) -> Actions) -> some View where Item: AlertProtocol, Actions: View {
|
||||
let binding = Binding<Bool>(get: {
|
||||
item.wrappedValue != nil
|
||||
}, set: { newValue in
|
||||
@@ -44,29 +44,69 @@ extension View {
|
||||
}
|
||||
}
|
||||
|
||||
// Only for Alerts that display a simple error message with a message and one or two buttons
|
||||
struct ErrorAlertItem: AlertItem {
|
||||
struct Action {
|
||||
var title: String
|
||||
var action: () -> Void
|
||||
/// A type that describes an alert to be shown to the user.
|
||||
///
|
||||
/// The alert info can be added to the view state bindings and used as an alert's `item`:
|
||||
/// ```
|
||||
/// view
|
||||
/// .alert(item: $context.alertInfo)
|
||||
/// ```
|
||||
struct AlertInfo<T: Hashable>: Identifiable, AlertProtocol {
|
||||
struct AlertButton {
|
||||
let title: String
|
||||
var role: ButtonRole?
|
||||
let action: (() -> Void)?
|
||||
}
|
||||
|
||||
var error: Error
|
||||
var title = L10n.commonError
|
||||
var message = L10n.errorUnknown
|
||||
var cancelAction = Action(title: L10n.actionOk, action: { })
|
||||
var primaryAction: Action?
|
||||
/// An identifier that can be used to distinguish one error from another.
|
||||
let id: T
|
||||
/// The alert's title.
|
||||
let title: String
|
||||
/// The alert's message (optional).
|
||||
var message: String?
|
||||
/// The alert's primary button title and action. Defaults to an Ok button with no action.
|
||||
var primaryButton = AlertButton(title: L10n.actionOk, action: nil)
|
||||
/// The alert's secondary button title and action.
|
||||
var secondaryButton: AlertButton?
|
||||
}
|
||||
|
||||
extension AlertInfo {
|
||||
/// Initialises the type with a generic title and message for an unknown error along with the default Ok button.
|
||||
/// - Parameters:
|
||||
/// - id: An ID that identifies the error.
|
||||
/// - error: The Error that occurred.
|
||||
init(id: T) {
|
||||
self.id = id
|
||||
title = L10n.commonError
|
||||
message = L10n.errorUnknown
|
||||
}
|
||||
|
||||
/// Initialises the type with the title from an `Error`'s localised description along with the default Ok button.
|
||||
///
|
||||
/// Currently this initialiser creates an alert for every error, however in the future it may be updated to filter
|
||||
/// out some specific errors such as cancellation and networking issues that create too much noise or are
|
||||
/// indicated to the user using other mechanisms.
|
||||
init(error: Error) where T == String {
|
||||
self.init(id: error.localizedDescription,
|
||||
title: error.localizedDescription)
|
||||
}
|
||||
}
|
||||
|
||||
extension View {
|
||||
func errorAlert(item: Binding<ErrorAlertItem?>) -> some View {
|
||||
func alert<T: Hashable>(item: Binding<AlertInfo<T>?>) -> some View {
|
||||
alert(item: item) { item in
|
||||
Button(item.cancelAction.title) { item.cancelAction.action() }
|
||||
if let primaryAction = item.primaryAction {
|
||||
Button(primaryAction.title) { primaryAction.action() }
|
||||
Button(item.primaryButton.title, role: item.primaryButton.role) {
|
||||
item.primaryButton.action?()
|
||||
}
|
||||
if let secondaryButton = item.secondaryButton {
|
||||
Button(secondaryButton.title, role: secondaryButton.role) {
|
||||
secondaryButton.action?()
|
||||
}
|
||||
}
|
||||
} message: { item in
|
||||
Text(item.message)
|
||||
if let message = item.message {
|
||||
Text(message)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,108 +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
|
||||
|
||||
/// A type that describes an alert to be shown to the user.
|
||||
///
|
||||
/// The alert info can be added to the view state bindings and used as an alert's `item`:
|
||||
/// ```
|
||||
/// MyView
|
||||
/// .alert(item: $viewModel.alertInfo) { $0.alert }
|
||||
/// ```
|
||||
struct AlertInfo<T: Hashable>: Identifiable {
|
||||
/// An identifier that can be used to distinguish one error from another.
|
||||
let id: T
|
||||
/// The alert's title.
|
||||
let title: String
|
||||
/// The alert's message (optional).
|
||||
var message: String?
|
||||
/// The alert's primary button title and action. Defaults to an Ok button with no action.
|
||||
var primaryButton = AlertButton(title: L10n.actionOk, action: nil)
|
||||
/// The alert's secondary button title and action.
|
||||
var secondaryButton: AlertButton?
|
||||
}
|
||||
|
||||
struct AlertButton {
|
||||
let title: String
|
||||
var role: Role = .default
|
||||
let action: (() -> Void)?
|
||||
|
||||
enum Role {
|
||||
case `default`, cancel, destructive
|
||||
}
|
||||
}
|
||||
|
||||
extension AlertInfo {
|
||||
/// Initialises the type with the title from an `Error`'s localised description along with the default Ok button.
|
||||
///
|
||||
/// Currently this initialiser creates an alert for every error, however in the future it may be updated to filter
|
||||
/// out some specific errors such as cancellation and networking issues that create too much noise or are
|
||||
/// indicated to the user using other mechanisms.
|
||||
init(error: Error) where T == String {
|
||||
self.init(id: error.localizedDescription,
|
||||
title: error.localizedDescription)
|
||||
}
|
||||
|
||||
/// Initialises the type with a generic title and message for an unknown error along with the default Ok button.
|
||||
/// - Parameters:
|
||||
/// - id: An ID that identifies the error.
|
||||
/// - error: The Error that occurred.
|
||||
init(id: T) {
|
||||
self.id = id
|
||||
title = L10n.commonError
|
||||
message = L10n.errorUnknown
|
||||
}
|
||||
}
|
||||
|
||||
extension AlertInfo {
|
||||
private var messageText: Text? {
|
||||
guard let message else { return nil }
|
||||
return Text(message)
|
||||
}
|
||||
|
||||
/// Returns a SwiftUI `Alert` created from this alert info, using default button
|
||||
/// styles for both primary and (if set) secondary buttons.
|
||||
var alert: Alert {
|
||||
if let secondaryButton {
|
||||
return Alert(title: Text(title),
|
||||
message: messageText,
|
||||
primaryButton: alertButton(for: primaryButton),
|
||||
secondaryButton: alertButton(for: secondaryButton))
|
||||
} else {
|
||||
return Alert(title: Text(title),
|
||||
message: messageText,
|
||||
dismissButton: alertButton(for: primaryButton))
|
||||
}
|
||||
}
|
||||
|
||||
private func alertButton(for buttonParameters: AlertButton) -> Alert.Button {
|
||||
switch (buttonParameters.role, buttonParameters.action) {
|
||||
case (.default, nil):
|
||||
return .default(Text(buttonParameters.title))
|
||||
case (.default, let action):
|
||||
return .default(Text(buttonParameters.title), action: action)
|
||||
case (.cancel, nil):
|
||||
return .cancel(Text(buttonParameters.title))
|
||||
case (.cancel, let action):
|
||||
return .cancel(Text(buttonParameters.title), action: action)
|
||||
case (.destructive, nil):
|
||||
return .destructive(Text(buttonParameters.title))
|
||||
case (.destructive, let action):
|
||||
return .destructive(Text(buttonParameters.title), action: action)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -40,8 +40,6 @@ struct UserIndicatorPresenter: View {
|
||||
}
|
||||
}
|
||||
}
|
||||
.alert(item: $userIndicatorController.alertInfo) {
|
||||
$0.alert
|
||||
}
|
||||
.alert(item: $userIndicatorController.alertInfo)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -46,7 +46,7 @@ struct LoginScreen: View {
|
||||
.padding(.bottom, 16)
|
||||
}
|
||||
.background(Color.element.background.ignoresSafeArea())
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
|
||||
/// The header containing the title and icon.
|
||||
|
||||
+1
-1
@@ -33,7 +33,7 @@ struct ServerSelectionScreen: View {
|
||||
}
|
||||
.background(Color.element.background.ignoresSafeArea())
|
||||
.toolbar { toolbar }
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.interactiveDismissDisabled()
|
||||
}
|
||||
|
||||
|
||||
+1
-1
@@ -48,7 +48,7 @@ struct SoftLogoutScreen: View {
|
||||
.padding(.bottom, 16)
|
||||
}
|
||||
.background(Color.element.background.ignoresSafeArea())
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.introspectViewController { viewController in
|
||||
guard let window = viewController.view.window else { return }
|
||||
context.send(viewAction: .updateWindow(window))
|
||||
|
||||
@@ -41,7 +41,7 @@ struct CreateRoomScreen: View {
|
||||
}
|
||||
}
|
||||
.background(ViewFrameReader(frame: $frame))
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
|
||||
@ScaledMetric private var roomIconSize: CGFloat = 70
|
||||
|
||||
@@ -116,7 +116,7 @@ struct HomeScreen: View {
|
||||
.animation(.elementDefault, value: context.viewState.showSessionVerificationBanner)
|
||||
.animation(.elementDefault, value: context.viewState.roomListMode)
|
||||
.animation(.none, value: context.viewState.visibleRooms)
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.alert(item: $context.leaveRoomAlertItem,
|
||||
actions: leaveRoomAlertActions,
|
||||
message: leaveRoomAlertMessage)
|
||||
|
||||
@@ -38,7 +38,7 @@ struct InviteUsersScreen: View {
|
||||
searchViewController.hidesNavigationBarDuringPresentation = false
|
||||
}
|
||||
.compoundSearchField()
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.background(ViewFrameReader(frame: $frame))
|
||||
}
|
||||
|
||||
|
||||
@@ -36,7 +36,7 @@ struct InvitesScreen: View {
|
||||
}
|
||||
.background(Color.element.background.ignoresSafeArea())
|
||||
.navigationTitle(L10n.actionInvitesList)
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
|
||||
// MARK: - Private
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
|
||||
import Foundation
|
||||
|
||||
enum LocationSharingViewError: Error {
|
||||
enum LocationSharingViewError: Error, Hashable {
|
||||
case failedSharingLocation
|
||||
case mapError(MapLibreError)
|
||||
}
|
||||
@@ -31,15 +31,18 @@ struct StaticLocationScreenBindings {
|
||||
/// Information describing the currently displayed alert.
|
||||
var mapError: MapLibreError? {
|
||||
get {
|
||||
errorAlert?.error as? MapLibreError
|
||||
if case let .mapError(error) = alertInfo?.id {
|
||||
return error
|
||||
}
|
||||
return nil
|
||||
}
|
||||
set {
|
||||
errorAlert = newValue.map { ErrorAlertItem(error: $0) }
|
||||
alertInfo = newValue.map { AlertInfo(id: .mapError($0)) }
|
||||
}
|
||||
}
|
||||
|
||||
/// Information describing the currently displayed alert.
|
||||
var errorAlert: ErrorAlertItem?
|
||||
var alertInfo: AlertInfo<LocationSharingViewError>?
|
||||
}
|
||||
|
||||
enum StaticLocationScreenViewAction { }
|
||||
|
||||
@@ -26,7 +26,7 @@ struct StaticLocationScreen: View {
|
||||
mapView
|
||||
.ignoresSafeArea(.all, edges: [.bottom])
|
||||
.navigationBarTitleDisplayMode(.inline)
|
||||
.errorAlert(item: $context.errorAlert)
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -61,7 +61,7 @@ struct RoomDetailsScreenViewState: BindableState {
|
||||
}
|
||||
|
||||
struct RoomDetailsScreenViewStateBindings {
|
||||
struct IgnoreUserAlertItem: AlertItem, Equatable {
|
||||
struct IgnoreUserAlertItem: AlertProtocol, Equatable {
|
||||
enum Action {
|
||||
case ignore
|
||||
case unignore
|
||||
@@ -105,7 +105,7 @@ struct RoomDetailsScreenViewStateBindings {
|
||||
var ignoreUserRoomAlertItem: IgnoreUserAlertItem?
|
||||
}
|
||||
|
||||
struct LeaveRoomAlertItem: AlertItem {
|
||||
struct LeaveRoomAlertItem: AlertProtocol {
|
||||
enum RoomState {
|
||||
case empty
|
||||
case `public`
|
||||
|
||||
@@ -42,7 +42,7 @@ struct RoomDetailsScreen: View {
|
||||
}
|
||||
}
|
||||
.elementFormStyle()
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.alert(item: $context.leaveRoomAlertItem,
|
||||
actions: leaveRoomAlertActions,
|
||||
message: leaveRoomAlertMessage)
|
||||
|
||||
+7
-2
@@ -26,7 +26,7 @@ struct RoomMemberDetailsScreenViewState: BindableState {
|
||||
}
|
||||
|
||||
struct RoomMemberDetailsScreenViewStateBindings {
|
||||
struct IgnoreUserAlertItem: AlertItem, Equatable {
|
||||
struct IgnoreUserAlertItem: AlertProtocol, Equatable {
|
||||
enum Action {
|
||||
case ignore
|
||||
case unignore
|
||||
@@ -65,7 +65,7 @@ struct RoomMemberDetailsScreenViewStateBindings {
|
||||
}
|
||||
|
||||
var ignoreUserAlert: IgnoreUserAlertItem?
|
||||
var errorAlert: ErrorAlertItem?
|
||||
var alertInfo: AlertInfo<RoomMemberDetailsScreenError>?
|
||||
}
|
||||
|
||||
enum RoomMemberDetailsScreenViewAction {
|
||||
@@ -74,3 +74,8 @@ enum RoomMemberDetailsScreenViewAction {
|
||||
case ignoreConfirmed
|
||||
case unignoreConfirmed
|
||||
}
|
||||
|
||||
enum RoomMemberDetailsScreenError: Hashable {
|
||||
case alert(String)
|
||||
case unknown
|
||||
}
|
||||
|
||||
+4
-4
@@ -55,8 +55,8 @@ class RoomMemberDetailsScreenViewModel: RoomMemberDetailsScreenViewModelType, Ro
|
||||
switch result {
|
||||
case .success:
|
||||
state.details.isIgnored = true
|
||||
case .failure(let error):
|
||||
state.bindings.errorAlert = .init(error: error)
|
||||
case .failure:
|
||||
state.bindings.alertInfo = .init(id: .unknown)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,8 +68,8 @@ class RoomMemberDetailsScreenViewModel: RoomMemberDetailsScreenViewModelType, Ro
|
||||
switch result {
|
||||
case .success:
|
||||
state.details.isIgnored = false
|
||||
case .failure(let error):
|
||||
state.bindings.errorAlert = .init(error: error)
|
||||
case .failure:
|
||||
state.bindings.alertInfo = .init(id: .unknown)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ struct RoomMemberDetailsScreen: View {
|
||||
}
|
||||
.elementFormStyle()
|
||||
.alert(item: $context.ignoreUserAlert, actions: blockUserAlertActions, message: blockUserAlertMessage)
|
||||
.errorAlert(item: $context.errorAlert)
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
|
||||
// MARK: - Private
|
||||
|
||||
@@ -33,7 +33,7 @@ struct RoomMembersListScreen: View {
|
||||
.compoundSearchField()
|
||||
.background(Color.element.background.ignoresSafeArea())
|
||||
.navigationTitle(L10n.commonPeople)
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.toolbar {
|
||||
ToolbarItem(placement: .confirmationAction) {
|
||||
inviteButton
|
||||
|
||||
@@ -37,7 +37,7 @@ struct RoomScreen: View {
|
||||
.toolbar { toolbar }
|
||||
.toolbarBackground(.visible, for: .navigationBar) // Fix the toolbar's background.
|
||||
.overlay { loadingIndicator }
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
.sheet(item: $context.debugInfo) { TimelineItemDebugView(info: $0) }
|
||||
.sheet(item: $context.actionMenuInfo) { info in
|
||||
context.viewState.timelineItemMenuActionProvider?(info.item.id).map { actions in
|
||||
|
||||
@@ -41,7 +41,7 @@ struct StartChatScreen: View {
|
||||
.dismissSearchOnDisappear()
|
||||
.searchable(text: $context.searchQuery, placement: .navigationBarDrawer(displayMode: .always), prompt: L10n.commonSearchForSomeone)
|
||||
.compoundSearchField()
|
||||
.alert(item: $context.alertInfo) { $0.alert }
|
||||
.alert(item: $context.alertInfo)
|
||||
}
|
||||
|
||||
// MARK: - Private
|
||||
|
||||
Reference in New Issue
Block a user