Release 12.0.0 (#501)

* Fix releasing instructions * Bump version to 12.0.0 * Generate docs
square · Aug 9, 2023 · 6e5f113 · 6e5f113
1 parent df408dd
commit 6e5f113
Show file tree

Hide file tree

Showing 462 changed files with 26,796 additions and 9,158 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,29 +4,34 @@
 
 ### Added
 
-- `ApplyItemContentInfo` and `ApplyHeaderFooterContentInfo` are now available in the Blueprint `Environment` for each `BlueprintItemContent`.
+### Removed
 
-- A new `isContentScrollable` property is added to `ListView` to determine if the content size is large enough that the list can be scrolled to a new position without springing back to it's original position.
+### Changed
 
-- A new `custom` case is added to `KeyboardAdjustmentMode` which allows the consumer to fully customize the inset behavior. `onKeyboardFrameWillChange` and `customScrollViewInsets` have been added to `ListView` and `updateScrollViewInsets` is now public. All of these can be utilized in conjunction to respond to the keyboard and fully control the insets. For now, these are available through `ListView` only.
+### Misc
 
-- A new `verticalLayoutGravity` behavior to accomodate vertical-layout lists where the normal scroll position of the list is at the bottom of the list. Setting `verticalLayoutGravity` to `.bottom` enables the new behavior. It's designed to accomodate a messaging client. Adds a new demo called Chat App.
+### Internal
 
-### Removed
+# Past Releases
+
+# [12.0.0] - 2023-08-08
+
+### Added
+
+- `ApplyItemContentInfo` and `ApplyHeaderFooterContentInfo` are now available in the Blueprint `Environment` for each `BlueprintItemContent`.
+- A new `isContentScrollable` property is added to `ListView` to determine if the content size is large enough that the list can be scrolled to a new position without springing back to it's original position.
+- A new `custom` case is added to `KeyboardAdjustmentMode` which allows the consumer to fully customize the inset behavior. `onKeyboardFrameWillChange` and `customScrollViewInsets` have been added to `ListView` and `updateScrollViewInsets` is now public. All of these can be utilized in conjunction to respond to the keyboard and fully control the insets. For now, these are available through `ListView` only.
+- A new `verticalLayoutGravity` behavior to accomodate vertical-layout lists where the normal scroll position of the list is at the bottom of the list. Setting `verticalLayoutGravity` to `.bottom` enables the new behavior. It's designed to accomodate a messaging client. Adds a new demo called Chat App.
 
 ### Changed
 
 - `SwipeAction` property names have been updated to better reflect what they're for. `Completion` also now takes in a more descriptive enum, instead of a boolean, to make reading callsites clearer. Eg, `completion(.expandActions)` instead of `completion(true)`.
 
-### Misc
-
 ### Internal
 
 - Update CI script to reference the `xcodesorg/made/xcodes` package for installing simulator runtimes.
 - Update CI script to install `aria2` to improve simulator runtime download speeds.
 
-# Past Releases
-
 # [11.0.0] - 2023-06-15
 
 ### Removed
@@ -963,7 +968,8 @@ listActions.scrolling.scrollToSection(
 Earlier releases were ad-hoc and not tracked. To see all changes, please reference [closed PRs on Github](https://github.com/kyleve/Listable/pulls?q=is%3Apr+is%3Aclosed).
 
 
-[Main]: https://github.com/square/Listable/square/11.0.0...HEAD
+[Main]: https://github.com/square/Listable/square/12.0.0...HEAD
+[12.0.0]: https://github.com/square/Listable/compare/11.0.0...12.0.0
 [11.0.0]: https://github.com/square/Listable/compare/10.3.1...11.0.0
 [10.3.1]: https://github.com/square/Listable/compare/10.3.0...10.3.1
 [10.3.0]: https://github.com/square/Listable/compare/10.2.0...10.3.0

diff --git a/Podfile.lock b/Podfile.lock
@@ -2,16 +2,16 @@ PODS:
   - BlueprintUI (2.0.0)
   - BlueprintUICommonControls (2.0.0):
     - BlueprintUI (= 2.0.0)
-  - BlueprintUILists (11.0.0):
+  - BlueprintUILists (12.0.0):
     - BlueprintUI (~> 2.0)
     - ListableUI
-  - BlueprintUILists/Tests (11.0.0):
+  - BlueprintUILists/Tests (12.0.0):
     - BlueprintUI (~> 2.0)
     - BlueprintUICommonControls (~> 2.0)
     - ListableUI
   - EnglishDictionary (1.0.0.LOCAL)
-  - ListableUI (11.0.0)
-  - ListableUI/Tests (11.0.0):
+  - ListableUI (12.0.0)
+  - ListableUI/Tests (12.0.0):
     - EnglishDictionary
     - Snapshot
   - Snapshot (1.0.0.LOCAL)
@@ -46,9 +46,9 @@ EXTERNAL SOURCES:
 SPEC CHECKSUMS:
   BlueprintUI: a1adeb91f76c88dd499ad693251aa96919b1c2a4
   BlueprintUICommonControls: 9e02875bc6b8ef64aa9634c32d7156bd50c7b88d
-  BlueprintUILists: 46435bdc6ac36187398b959ec015a30dcb233be3
+  BlueprintUILists: d836ff516e3fec7635f22241bc9fe7ceb411f06b
   EnglishDictionary: 277ff15917abc170362afbd2ad11cbe15c2ae6ad
-  ListableUI: 7d76e45523819477f809dcaeabdedad0eb0d8da0
+  ListableUI: edd054decf316f50c1fc94a756e4e405b56e4733
   Snapshot: a936e73ede9570c80fb55e20542903e81efbad82
 
 PODFILE CHECKSUM: 2ca1d80570fc765312a79bcaa886ee9034caabd2

diff --git a/RELEASING.md b/RELEASING.md
@@ -23,18 +23,18 @@
   
    The changelog uses [reference links](https://daringfireball.net/projects/markdown/syntax#link) to link each version's changes. Remember to add a link to the new version at the bottom of the file, and to update the link to `[main]`.
 
-1. Re-generate the documentation.
-   ```bash
-   bundle exec Scripts/generate_docs.sh
-   ```
-
 1. Run `bundle exec pod install` to update the `Podfile.lock` with the new versions.
 
 1. Commit the podspec version bumps and the `Podfile.lock` update.
    ```bash
    git commit -am "Bumping versions to 0.1.0."
    ```
 
+1. Re-generate the documentation.
+   ```bash
+   bundle exec Scripts/generate_docs.sh
+   ```
+
 1. Push your branch and open a PR into `main`.
 
 1. Once the PR is merged, fetch changes and tag the release, using the merge commit:

diff --git a/docs/BlueprintLists/Enums.html b/docs/BlueprintLists/Enums.html
@@ -185,7 +185,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Enums/ListContentContextKey.html b/docs/BlueprintLists/Enums/ListContentContextKey.html
@@ -190,7 +190,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Extensions.html b/docs/BlueprintLists/Extensions.html
@@ -212,7 +212,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Extensions/Element.html b/docs/BlueprintLists/Extensions/Element.html
@@ -195,7 +195,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Extensions/Environment.html b/docs/BlueprintLists/Extensions/Environment.html
@@ -156,6 +156,62 @@ <h1>Environment</h1>
           <div class="section-content">
             <div class="task-group">
               <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:11BlueprintUI11EnvironmentV0A7UIListsE28applyHeaderFooterContentInfo08ListableB005ApplyfghI0VSgvp"></a>
+                    <a name="//apple_ref/swift/Property/applyHeaderFooterContentInfo" class="dashAnchor"></a>
+                    <a class="token" href="#/s:11BlueprintUI11EnvironmentV0A7UIListsE28applyHeaderFooterContentInfo08ListableB005ApplyfghI0VSgvp">applyHeaderFooterContentInfo</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>The <code>ApplyHeaderFooterContentInfo</code> which was passed to the <code>HeaderFooter</code> before it was
+last displayed or updated. Nil if not in a Listable <code>HeaderFooter</code>.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">applyHeaderFooterContentInfo</span><span class="p">:</span> <span class="kt">ApplyHeaderFooterContentInfo</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:11BlueprintUI11EnvironmentV0A7UIListsE20applyItemContentInfo08ListableB005ApplyfgH0VSgvp"></a>
+                    <a name="//apple_ref/swift/Property/applyItemContentInfo" class="dashAnchor"></a>
+                    <a class="token" href="#/s:11BlueprintUI11EnvironmentV0A7UIListsE20applyItemContentInfo08ListableB005ApplyfgH0VSgvp">applyItemContentInfo</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>The <code>ApplyItemContentInfo</code> which was passed to the <code>Item</code> before it was
+last displayed or updated. Nil if not in a Listable <code>Item</code>.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">applyItemContentInfo</span><span class="p">:</span> <span class="kt">ApplyItemContentInfo</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -193,7 +249,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Functions.html b/docs/BlueprintLists/Functions.html
@@ -433,7 +433,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Protocols.html b/docs/BlueprintLists/Protocols.html
@@ -303,7 +303,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Protocols/BlueprintHeaderFooterContent.html b/docs/BlueprintLists/Protocols/BlueprintHeaderFooterContent.html
@@ -454,7 +454,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Protocols/BlueprintItemContent.html b/docs/BlueprintLists/Protocols/BlueprintItemContent.html
@@ -609,7 +609,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Structs.html b/docs/BlueprintLists/Structs.html
@@ -322,7 +322,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Structs/ElementHeaderFooterContent.html b/docs/BlueprintLists/Structs/ElementHeaderFooterContent.html
@@ -297,7 +297,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Structs/ElementItemContent.html b/docs/BlueprintLists/Structs/ElementItemContent.html
@@ -323,7 +323,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Structs/List.html b/docs/BlueprintLists/Structs/List.html
@@ -422,7 +422,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/BlueprintLists/Structs/List/Measurement.html b/docs/BlueprintLists/Structs/List/Measurement.html
@@ -368,7 +368,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-05-17)</p>
+      <p>&copy; 2023 <a class="link" href="https://github.com/kyleve/Listable" target="_blank" rel="external noopener">Kyle</a>. All rights reserved. (Last updated: 2023-08-08)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>