refactor: 💡 [HCPSDKFIORIUIKIT-2232]SortFilterView NoteFormView (SAP#1024)

* refactor: 💡 [HCPSDKFIORIUIKIT-2232]SortFilterView NoteFormView

* refactor: 💡 [HCPSDKFIORIUIKIT-2232]SortFilterView NoteFormView

---------

Co-authored-by: dyongxu <[email protected]>

Author: restaurantt

Apps/Examples/Examples/FioriSwiftUICore/SortFilter/SortFilterExample.swift

@@ -39,7 +39,8 @@ struct SortFilterExample: View {
             .datetime(item: .init(name: "Completion Date", value: nil), showsOnFilterFeedbackBar: true)
         ],
         [
-            .title(item: .init(name: "Title", text: "This is default text.", placeholder: "Please input", maxTextLength: 20, isCharCountEnabled: true, charCountBeyondLimitMsg: "CharCountBeyondLimit"), showsOnFilterFeedbackBar: true)
+            .title(item: .init(name: "Title", text: "This is default text.", placeholder: "Please input", maxTextLength: 20, isCharCountEnabled: true, charCountBeyondLimitMsg: "Char count beyond limit"), showsOnFilterFeedbackBar: true),
+            .note(item: .init(name: "Note", text: "This is default text.", placeholder: "Please input", maxTextLength: 200, isCharCountEnabled: true, charCountBeyondLimitMsg: "Char count beyond limit"), showsOnFilterFeedbackBar: false)
         ]
     ]
 

Apps/Examples/Examples/FioriSwiftUICore/SortFilter/SortFilterView+Extensions.swift

@@ -18,6 +18,8 @@ extension View {
             return self.json(item: v)
         case .title(let v, _):
             return self.json(item: v)
+        case .note(let v, _):
+            return self.json(item: v)
         }
     }
 
@@ -44,4 +46,8 @@ extension View {
     func json(item: SortFilterItem.TitleItem) -> String {
         "{name: \(item.name), value: \(item.text)}"
     }
+    
+    func json(item: SortFilterItem.NoteItem) -> String {
+        "{name: \(item.name), value: \(item.text)}"
+    }
 }

Sources/FioriSwiftUICore/DataTypes/SortFilter+DataType.swift

@@ -20,6 +20,8 @@ public enum SortFilterItem: Identifiable, Hashable {
             return item.id
         case .title(let item, _):
             return item.id
+        case .note(let item, _):
+            return item.id
         }
     }
 
@@ -75,6 +77,14 @@ public enum SortFilterItem: Identifiable, Hashable {
     ///
     /// 2. A section of view containing a SwiftUI TitleFormView with Fiori style
     case title(item: TitleItem, showsOnFilterFeedbackBar: Bool)
+    
+    /// The type of UI control is used to build:
+    /// Typically not used in FilterFeedbackBar.
+    ///
+    /// 1. Sort & Filter's menu item associated with a popover containing a SwiftUI NoteFormView with Fiori style
+    ///
+    /// 2. A section of view containing a SwiftUI NoteFormView with Fiori style
+    case note(item: NoteItem, showsOnFilterFeedbackBar: Bool)
 
     public var showsOnFilterFeedbackBar: Bool {
         switch self {
@@ -92,6 +102,8 @@ public enum SortFilterItem: Identifiable, Hashable {
             return showsOnFilterFeedbackBar
         case .title(_, let showsOnFilterFeedbackBar):
             return showsOnFilterFeedbackBar
+        case .note(_, let showsOnFilterFeedbackBar):
+            return showsOnFilterFeedbackBar
         }
     }
 
@@ -133,6 +145,11 @@ public enum SortFilterItem: Identifiable, Hashable {
             hasher.combine(item.originalText)
             hasher.combine(item.workingText)
             hasher.combine(item.text)
+        case .note(let item, _):
+            hasher.combine(item.id)
+            hasher.combine(item.originalText)
+            hasher.combine(item.workingText)
+            hasher.combine(item.text)
         }
     }
 }
@@ -278,6 +295,26 @@ extension SortFilterItem {
         }
     }
 
+    var note: NoteItem {
+        get {
+            switch self {
+            case .note(let item, _):
+                return item
+            default:
+                fatalError("Unexpected value \(self)")
+            }
+        }
+        
+        set {
+            switch self {
+            case .note(_, let showsOnFilterFeedbackBar):
+                self = .note(item: newValue, showsOnFilterFeedbackBar: showsOnFilterFeedbackBar)
+            default:
+                fatalError("Unexpected value \(self)")
+            }
+        }
+    }
+    
     var isChanged: Bool {
         switch self {
         case .picker(let item, _):
@@ -294,6 +331,8 @@ extension SortFilterItem {
             return item.isChanged
         case .title(let item, _):
             return item.isChanged
+        case .note(let item, _):
+            return item.isChanged
         }
     }
 
@@ -313,6 +352,8 @@ extension SortFilterItem {
             return item.isOriginal
         case .title(let item, _):
             return item.isOriginal
+        case .note(let item, _):
+            return item.isOriginal
         }
     }
 
@@ -339,6 +380,9 @@ extension SortFilterItem {
         case .title(var item, _):
             item.cancel()
             self.title = item
+        case .note(var item, _):
+            item.cancel()
+            self.note = item
         }
     }
 
@@ -365,6 +409,9 @@ extension SortFilterItem {
         case .title(var item, _):
             item.reset()
             self.title = item
+        case .note(var item, _):
+            item.reset()
+            self.note = item
         }
     }
 
@@ -391,6 +438,9 @@ extension SortFilterItem {
         case .title(var item, _):
             item.apply()
             self.title = item
+        case .note(var item, _):
+            item.apply()
+            self.note = item
         }
     }
 }
@@ -1175,4 +1225,94 @@ public extension SortFilterItem {
             "\(self.name): \(self.text)"
         }
     }
+    
+    /// Data structure for note type
+    struct NoteItem: Identifiable, Equatable {
+        public var id: String
+        public var name: String
+        public let icon: String?
+        
+        public var text: String
+        var workingText: String
+        let originalText: String
+        public var placeholder: String?
+        public var controlState: ControlState = .normal
+        public var errorMessage: String?
+        public var maxTextLength: Int?
+        public let hintText: String?
+        public let hidesReadOnlyHint: Bool
+        public let isCharCountEnabled: Bool
+        public let allowsBeyondLimit: Bool
+        public let charCountReachLimitMessage: String?
+        public let charCountBeyondLimitMsg: String?
+        public let minTextEditorHeight: CGFloat?
+        public let maxTextEditorHeight: CGFloat?
+        
+        /// Create a textfiled.
+        /// - Parameters:
+        ///   - id: The unique identifier for TitleItem.
+        ///   - name: Item name.
+        ///   - text: The text in textfield.
+        ///   - placeholder: A text for placeholder of textfield.
+        ///   - controlState: A state for textfield.
+        ///   - errorMessage: A text when the text of textfield not satisfy conditions.
+        ///   - minTextEditorHeight: The minimum height of the TextEditor. It needs to be greater than 44. Otherwise, it is ignored.
+        ///   - maxTextEditorHeight The maximum height of the TextEditor.
+        ///   - maxTextLength: A maximum value for text length.
+        ///   - hidesReadOnlyHint: A boolean value to indicate to hide read only hint or not.
+        ///   - isCharCountEnabled: A boolean value to indicate to display char count or not.
+        ///   - allowsBeyondLimit: A boolean value to indicate to allows inputting text beyond maximum char count limit or not.
+        ///   - charCountReachLimitMessage: A text for char count reach maximum limit.
+        ///   - charCountBeyondLimitMsg: A text for char beyond maximum limit.
+        ///   - icon: The icon image in the item bar.
+        ///   - hintText: The hint text of the textfiled.
+        public init(id: String = UUID().uuidString, name: String, text: String, isSecureEnabled: Bool? = false, placeholder: String? = nil, controlState: ControlState = .normal, errorMessage: String? = nil, minTextEditorHeight: CGFloat? = nil, maxTextEditorHeight: CGFloat? = nil, maxTextLength: Int? = nil, hidesReadOnlyHint: Bool = false, isCharCountEnabled: Bool = false, allowsBeyondLimit: Bool = false, charCountReachLimitMessage: String? = nil, charCountBeyondLimitMsg: String? = nil, icon: String? = nil, hintText: String? = nil) {
+            self.id = id
+            self.name = name
+            self.text = text
+            self.workingText = text
+            self.originalText = text
+            self.icon = icon
+            self.placeholder = placeholder
+            self.controlState = controlState
+            self.minTextEditorHeight = minTextEditorHeight
+            self.maxTextEditorHeight = maxTextEditorHeight
+            self.errorMessage = errorMessage
+            self.maxTextLength = maxTextLength
+            self.hidesReadOnlyHint = hidesReadOnlyHint
+            self.isCharCountEnabled = isCharCountEnabled
+            self.allowsBeyondLimit = allowsBeyondLimit
+            self.charCountReachLimitMessage = charCountReachLimitMessage
+            self.charCountBeyondLimitMsg = charCountBeyondLimitMsg
+            self.hintText = hintText
+        }
+        
+        mutating func reset() {
+            self.workingText = self.originalText
+        }
+        
+        mutating func cancel() {
+            self.workingText = self.text
+        }
+        
+        mutating func apply() {
+            self.text = self.workingText
+        }
+        
+        var isChecked: Bool {
+            !self.text.isEmpty
+        }
+        
+        var isChanged: Bool {
+            self.text != self.workingText
+        }
+        
+        var isOriginal: Bool {
+            self.workingText == self.originalText
+        }
+        
+        var label: String {
+            "\(self.name): \(self.text)"
+        }
+    }
 }

Sources/FioriSwiftUICore/Views/SortFilter/FilterFeedbackBarItemContainer.swift

@@ -68,6 +68,11 @@ extension FilterFeedbackBarItemContainer: View {
                                     .accessibilityElement()
                                     .accessibilityLabel(self._items[r][c].title.label)
                                     .accessibilityIdentifier(self._items[r][c].title.name)
+                            case .note:
+                                NoteMenuItem(item: Binding<SortFilterItem.NoteItem>(get: { self._items[r][c].note }, set: { self._items[r][c].note = $0 }), onUpdate: self.onUpdate)
+                                    .accessibilityElement()
+                                    .accessibilityLabel(self._items[r][c].note.label)
+                                    .accessibilityIdentifier(self._items[r][c].note.name)
                             }
                         }
                     }