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

Refactored alert info to not use the soon to be deprecated API (#1084)

Browse Source 
* 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
2023-06-14 16:24:10 +02:00
committed by GitHub
parent 8b5c105dfe
commit 2cfc844545
24 changed files with 107 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ElementX/Sources/Other/Extensions/Alert.swift
+58 -18
View File
@@ -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)
}
}
}
}
ElementX/Sources/Other/SwiftUI/ErrorHandling/AlertInfo.swift
-108
View File
@@ -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)
}
}
}
ElementX/Sources/Other/UserIndicator/UserIndicatorPresenter.swift
+1 -3
View File
@@ -40,8 +40,6 @@ struct UserIndicatorPresenter: View {
}
}
}
.alert(item: $userIndicatorController.alertInfo) {
$0.alert
}
.alert(item: $userIndicatorController.alertInfo)
}
}