refactor: 💡 object header (#948)

* refactor: 💡 object header

* feat: 🎸 add doc and usage

* feat: 🎸 add doc

Author: xiaoyu0722

Sources/FioriSwiftUICore/Models/ModelDefinitions.swift

@@ -40,7 +40,10 @@ public protocol TagStackModel: TagsComponent {}
 // sourcery: virtualPropStatusViewSize = "@State var statusViewSize: CGSize = .zero"
 // sourcery: virtualPropCurrentTabIndex = "@State var currentTabIndex: Int = 0"
 // sourcery: generated_component_composite
-public protocol ObjectHeaderModel: TitleComponent, SubtitleComponent, TagsComponent, BodyTextComponent, FootnoteComponent, DescriptionTextComponent, StatusComponent, SubstatusComponent, DetailImageComponent {}
+public protocol _ObjectHeaderModel: TitleComponent, SubtitleComponent, TagsComponent, BodyTextComponent, FootnoteComponent, DescriptionTextComponent, StatusComponent, SubstatusComponent, DetailImageComponent {}
+
+@available(*, unavailable, renamed: "_ObjectHeaderModel", message: "Will be removed in the future release. Please create ObjectHeader with other initializers instead.")
+public protocol ObjectHeaderModel {}
 
 // sourcery: add_view_builder_params = "chart"
 // sourcery: virtualPropIntStateChanged = "@State var mainViewSize: CGSize = CGSize(width: 312, height: 0)"

…wiftUICore/Views/ObjectHeader+View.swift …iftUICore/Views/_ObjectHeader+View.swiftSources/FioriSwiftUICore/Views/ObjectHeader+View.swift renamed to Sources/FioriSwiftUICore/Views/_ObjectHeader+View.swift Sources/FioriSwiftUICore/Views/ObjectHeader+View.swift renamed to Sources/FioriSwiftUICore/Views/_ObjectHeader+View.swift

@@ -1,7 +1,7 @@
 import FioriCharts
 import SwiftUI
 
-public extension ObjectHeader where Title == Text,
+public extension _ObjectHeader where Title == Text,
     Subtitle == _ConditionalContent<Text, EmptyView>,
     Tags == _ConditionalContent<TagStack, EmptyView>,
     BodyText == _ConditionalContent<Text, EmptyView>,
@@ -37,7 +37,7 @@ public extension ObjectHeader where Title == Text,
 }
 
 extension Fiori {
-    enum ObjectHeader {
+    enum _ObjectHeader {
         struct Title: ViewModifier {
             func body(content: Content) -> some View {
                 if #available(iOS 14.0, *) {
@@ -156,7 +156,7 @@ extension Fiori {
  else descriptionView will get its own page
  */
 
-extension ObjectHeader: View {
+extension _ObjectHeader: View {
     public var body: some View {
         Group {
             if horizontalSizeClass == .some(.compact) {
@@ -609,17 +609,17 @@ struct ObjectHeader_Preview: PreviewProvider {
         })
 
         return Group {
-            ObjectHeader(title: "Transformer Overheating",
-                         subtitle: "Three Phase Pad Mounted Transformer (533423)", footnote: "1000 - Hamburg, MECHANIK",
-                         descriptionText: "Customer noticed that the transformer started to over heat within 45 minutes each time he turned it on at 7:30am.  The first technician who looked at this did not have the correct additional tools to complete the job.",
-                         status: TextOrIcon.text("High"), substatus: TextOrIcon.text("Scheduled"),
-                         detailImage: Image(systemName: "person"),
-                         detailContent: { hc })
+            _ObjectHeader(title: "Transformer Overheating",
+                          subtitle: "Three Phase Pad Mounted Transformer (533423)", footnote: "1000 - Hamburg, MECHANIK",
+                          descriptionText: "Customer noticed that the transformer started to over heat within 45 minutes each time he turned it on at 7:30am.  The first technician who looked at this did not have the correct additional tools to complete the job.",
+                          status: TextOrIcon.text("High"), substatus: TextOrIcon.text("Scheduled"),
+                          detailImage: Image(systemName: "person"),
+                          detailContent: { hc })
                 .previewLayout(.fixed(width: 390, height: 150))
                 .environment(\.horizontalSizeClass, .compact)
 
             // page 6
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines")
             }, subtitle: {
                 Text("Job 819701")
@@ -644,7 +644,7 @@ struct ObjectHeader_Preview: PreviewProvider {
             .environment(\.horizontalSizeClass, .regular)
             .environment(\.colorScheme, .dark)
 
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines")
             }, subtitle: {
                 Text("Job 819701")
@@ -657,7 +657,7 @@ struct ObjectHeader_Preview: PreviewProvider {
             .environment(\.horizontalSizeClass, .regular)
             .environment(\.colorScheme, .dark)
 
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines")
             }, subtitle: {
                 Text("Job 819701")
@@ -680,7 +680,7 @@ struct ObjectHeader_Preview: PreviewProvider {
             .environment(\.horizontalSizeClass, .regular)
             .environment(\.colorScheme, .dark)
 
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines")
             }, subtitle: {
                 Text("Job 819701")
@@ -697,7 +697,7 @@ struct ObjectHeader_Preview: PreviewProvider {
             .environment(\.horizontalSizeClass, .regular)
             .environment(\.colorScheme, .dark)
 
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines Accessibility Settings Testing")
             }, subtitle: {
                 Text("Job 819701 Accessibility Settings Testing")
@@ -713,7 +713,7 @@ struct ObjectHeader_Preview: PreviewProvider {
             .environment(\.colorScheme, .dark)
             .environment(\.sizeCategory, .extraExtraLarge)
 
-            ObjectHeader(title: {
+            _ObjectHeader(title: {
                 Text("Inspect Electric Pump Motor Long Job Title Example Wrapping Two Lines Accessibility Settings Testing")
             }, subtitle: {
                 Text("Job 819701 Accessibility Settings Testing")

Sources/FioriSwiftUICore/_ComponentProtocols/BaseComponentProtocols.swift

@@ -54,6 +54,12 @@ protocol _DescriptionComponent {
     var description: AttributedString? { get }
 }
 
+// sourcery: BaseComponent
+protocol _DescriptionTextComponent {
+    // sourcery: @ViewBuilder
+    var descriptionText: AttributedString? { get }
+}
+
 // sourcery: BaseComponent
 protocol _StatusComponent {
     // sourcery: resultBuilder.name = @ViewBuilder, resultBuilder.backingComponent = TextOrIconView
@@ -543,6 +549,18 @@ protocol _LineComponent {
     var line: (() -> any View)? { get }
 }
 
+// sourcery: BaseComponent
+protocol _BodyTextComponent {
+    // sourcery: @ViewBuilder
+    var bodyText: AttributedString? { get }
+}
+
+// sourcery: BaseComponent
+protocol _DetailContentComponent {
+    @ViewBuilder
+    var detailContent: (() -> any View)? { get }
+}
+
 // sourcery: BaseComponent
 protocol _InnerCircleComponent {
     // sourcery: @ViewBuilder

Sources/FioriSwiftUICore/_ComponentProtocols/CompositeComponentProtocols.swift

@@ -1021,3 +1021,31 @@ protocol _StepProgressIndicatorComponent: _TitleComponent, _ActionComponent, _Ca
     // sourcery: resultBuilder.returnType = any IndexedViewContainer
     var steps: [StepItem] { get }
 }
+
+/// `ObjectHeader` is a view that displays an object's title, subtitle, tags, body text, footnote, description, status, substatus, detail image and detail content.
+/// ## Usage
+/// ```swift
+/// ObjectHeader {
+///     Text("title")
+/// } subtitle: {
+///     Text("subtitle")
+/// } tags: {
+///     Text("tag01")
+/// } bodyText: {
+///     Text("body")
+/// } footnote: {
+///     Text("footnote")
+/// } descriptionText: {
+///     Text("description")
+/// } status: {
+///     Text("status")
+/// } substatus: {
+///     Text("substatus")
+/// } detailImage: {
+///     Image(systemName: "person")
+/// } detailContent: {
+///     Text("detail content")
+/// }
+/// ```
+// sourcery: CompositeComponent
+protocol _ObjectHeaderComponent: _TitleComponent, _SubtitleComponent, _TagsComponent, _BodyTextComponent, _FootnoteComponent, _DescriptionTextComponent, _StatusComponent, _SubstatusComponent, _DetailImageComponent, _DetailContentComponent {}

Sources/FioriSwiftUICore/_FioriStyles/BodyTextStyle.fiori.swift

@@ -0,0 +1,19 @@
+import FioriThemeManager
+import Foundation
+import SwiftUI
+
+// Base Layout style
+public struct BodyTextBaseStyle: BodyTextStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: BodyTextConfiguration) -> some View {
+        configuration.bodyText
+    }
+}
+
+// Default fiori styles
+public struct BodyTextFioriStyle: BodyTextStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: BodyTextConfiguration) -> some View {
+        BodyText(configuration)
+    }
+}

Sources/FioriSwiftUICore/_FioriStyles/DescriptionTextStyle.fiori.swift

@@ -0,0 +1,20 @@
+import FioriThemeManager
+import Foundation
+import SwiftUI
+
+// Base Layout style
+public struct DescriptionTextBaseStyle: DescriptionTextStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: DescriptionTextConfiguration) -> some View {
+        // Add default layout here
+        configuration.descriptionText
+    }
+}
+
+// Default fiori styles
+public struct DescriptionTextFioriStyle: DescriptionTextStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: DescriptionTextConfiguration) -> some View {
+        DescriptionText(configuration)
+    }
+}

Sources/FioriSwiftUICore/_FioriStyles/DetailContentStyle.fiori.swift

@@ -0,0 +1,19 @@
+import FioriThemeManager
+import Foundation
+import SwiftUI
+
+// Base Layout style
+public struct DetailContentBaseStyle: DetailContentStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: DetailContentConfiguration) -> some View {
+        configuration.detailContent
+    }
+}
+
+// Default fiori styles
+public struct DetailContentFioriStyle: DetailContentStyle {
+    @ViewBuilder
+    public func makeBody(_ configuration: DetailContentConfiguration) -> some View {
+        DetailContent(configuration)
+    }
+}