Rename var content to var body (#85)

* rename content to body

* readme, comments, benchmarks

Author: sliemeobn

.swift-version

@@ -0,0 +1 @@
+6.2.1

Benchmarks/Benchmarks/ElementaryBenchmarks/Benchmarks.swift

@@ -252,15 +252,15 @@ struct MyCustomElement<H: HTML>: HTML {
         myContent = content()
     }
 
-    var content: some HTML {
+    var body: some HTML {
         myContent
     }
 }
 
 struct MyListItem: HTML {
     let number: Int
 
-    var content: some HTML {
+    var body: some HTML {
         let isEven = number.isMultiple(of: 2)
 
         li(.id("\(number)")) {

Examples/HummingbirdDemo/.swift-version

@@ -0,0 +1 @@
+6.2.1

Examples/HummingbirdDemo/Sources/App/Pages.swift

@@ -25,7 +25,7 @@ struct MainLayout<Body: HTML>: HTMLDocument {
 }
 
 struct WelcomePage: HTML {
-    var content: some HTML {
+    var body: some HTML {
         div(.class("flex flex-col gap-4")) {
             p {
                 "This is a simple example of using "
@@ -52,7 +52,7 @@ struct GreetingPage: HTML {
     @Environment(requiring: EnvironmentValues.$name) var name
     var greetingCount: Int
 
-    var content: some HTML {
+    var body: some HTML {
         if greetingCount < 1 {
             p(.class("text-red-500")) {
                 "No greetings to show."

README.md

@@ -35,7 +35,7 @@ struct MainPage: HTMLDocument {
 struct FeatureList: HTML {
     var features: [String]
 
-    var content: some HTML {
+    var body: some HTML {
         ul {
             for feature in features {
                 li { feature }
@@ -122,7 +122,7 @@ struct List: HTML {
     var items: [String]
     var importantIndex: Int
 
-    var content: some HTML {
+    var body: some HTML {
         // conditional rendering
         if items.isEmpty {
             p { "No items" }
@@ -142,7 +142,7 @@ struct ListItem: HTML {
     var text: String
     var isImportant: Bool = false
 
-    var content: some HTML {
+    var body: some HTML {
         // conditional attributes
         li { text }
             .attributes(.class("important"), when: isImportant)
@@ -183,7 +183,7 @@ struct Button: HTML {
     var text: String
 
     // by exposing the HTMLTag type information...
-    var content: some HTML<HTMLTag.input> {
+    var body: some HTML<HTMLTag.input> {
         input(.type(.button), .value(text))
     }
 }
@@ -209,7 +209,7 @@ div {
 }
 
 struct MyComponent: HTML {
-    var content: some HTML {
+    var body: some HTML {
         AsyncContent {
             "So does this: \(await getMoreData())"
         }
@@ -245,7 +245,7 @@ struct MyComponent: HTML {
     // ... their values can be accessed ...
     @Environment(MyValues.$userName) var userName
 
-    var content: some HTML {
+    var body: some HTML {
         p { "Hello, \(userName)!" }
     }
 }

Sources/Elementary/Core/AsyncContent.swift

@@ -3,9 +3,11 @@
 /// The this element can only be rendered in an async context (ie: by calling ``HTML/render(into:chunkSize:)`` or ``HTML/renderAsync()``).
 /// All HTML tag types (``HTMLElement``) support async content closures in their initializers, so you don't need to use this element directly in most cases.
 public struct AsyncContent<Content: HTML>: HTML, Sendable {
+    public typealias Body = Never
+    public typealias Tag = Content.Tag
+
     @usableFromInline
     var content: @Sendable () async throws -> Content
-    public typealias Tag = Content.Tag
 
     /// Creates a new async HTML element with the specified content.
     ///

Sources/Elementary/Core/AsyncForEach.swift

@@ -12,6 +12,8 @@
 /// }
 /// ```
 public struct AsyncForEach<Source: AsyncSequence, Content: HTML>: HTML {
+    public typealias Body = Never
+
     @usableFromInline
     var sequence: Source
     @usableFromInline

Sources/Elementary/Core/CoreModel.swift

@@ -7,7 +7,7 @@
 /// struct FeatureList: HTML {
 ///   var features: [String]
 ///
-///   var content: some HTML {
+///   var body: some HTML {
 ///     ul {
 ///       for feature in features {
 ///         li { feature }
@@ -22,13 +22,18 @@ public protocol HTML<Tag> {
     /// The Tag type defines which attributes can be attached to an HTML element.
     /// If an element does not represent a specific HTML tag, the Tag type will
     /// be ``Swift/Never`` and the element cannot be attributed.
-    associatedtype Tag: HTMLTagDefinition = Content.Tag
+    associatedtype Tag: HTMLTagDefinition = Body.Tag
 
     /// The type of the HTML content this component represents.
-    associatedtype Content: HTML = Never
+    associatedtype Body: HTML
 
     /// The HTML content of this component.
-    @HTMLBuilder var content: Content { get }
+    @HTMLBuilder var body: Body { get }
+
+    /// The HTML content of this component.
+    @HTMLBuilder
+    @available(*, deprecated, message: "`var content` is deprecated, use `var body` instead")
+    var content: Body { get }
 
     static func _render<Renderer: _HTMLRendering>(
         _ html: consuming Self,
@@ -42,6 +47,21 @@ public protocol HTML<Tag> {
     ) async throws
 }
 
+extension HTML {
+    @available(*, deprecated, message: "`var content` is deprecated, use `var body` instead")
+    public var body: Body {
+        // NOTE: sorry for the change
+        content
+    }
+
+    @available(*, deprecated, message: "Content was renamed, use Body instead")
+    public typealias Content = Body
+
+    public var content: Body {
+        fatalError("Please make sure to add a `var body` implementation to your HTML type.")
+    }
+}
+
 /// A type that represents an HTML tag.
 public protocol HTMLTagDefinition: Sendable {
     /// The name of the HTML tag as it is rendered in an HTML document.
@@ -93,7 +113,7 @@ public extension HTML {
         into renderer: inout Renderer,
         with context: consuming _RenderingContext
     ) {
-        Content._render(html.content, into: &renderer, with: context)
+        Body._render(html.body, into: &renderer, with: context)
     }
 
     @inlinable
@@ -102,7 +122,7 @@ public extension HTML {
         into renderer: inout Renderer,
         with context: consuming _RenderingContext
     ) async throws {
-        try await Content._render(html.content, into: &renderer, with: context)
+        try await Body._render(html.body, into: &renderer, with: context)
     }
 }
 

Sources/Elementary/Core/Environment.swift

@@ -11,7 +11,7 @@
 /// struct MyNumber: HTML {
 ///     @Environment(Values.$myNumber) var number
 ///
-///     var content: some HTML {
+///     var body: some HTML {
 ///         p { "\(number)" }
 ///     }
 /// }

Sources/Elementary/Core/Html+Attributes.swift

@@ -64,6 +64,9 @@ extension HTMLAttribute {
 }
 
 public struct _AttributedElement<Content: HTML>: HTML {
+    public typealias Body = Never
+    public typealias Tag = Content.Tag
+
     public var content: Content
     public var attributes: _AttributeStorage