Skip to content

Commit

Permalink
Merge pull request #214 from Shopify/update-docs
Browse files Browse the repository at this point in the history
Update docs after branch rename `master` -> `main`
  • Loading branch information
Caiopia authored Apr 9, 2024
2 parents 00f980c + e75d3aa commit b4f7c99
Show file tree
Hide file tree
Showing 44 changed files with 302 additions and 308 deletions.
2 changes: 1 addition & 1 deletion .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
github_url: https://github.com/shopify/FunctionalTableData
github_file_prefix: https://github.com/shopify/FunctionalTableData/tree/master
github_file_prefix: https://github.com/shopify/FunctionalTableData/tree/main
skip_undocumented: true
hide_documentation_coverage: true
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://github.com/Shopify/FunctionalTableData/raw/master/Images/Banner.png" />
<img src="https://github.com/Shopify/FunctionalTableData/raw/main/Images/Banner.png" />

Functional Table Data implements a functional renderer for UITableView. You pass it a complete description of your table state, and Functional Table Data compares it with the previous render call to insert, update, and remove the sections and cells that have changed. This massively simplifies state management of complex UI.

Expand Down Expand Up @@ -73,7 +73,7 @@ After assigning the variable `rows` to our previously created `section`, all tha
functionalTableData.renderAndDiff([section])
```

<img src="https://github.com/Shopify/FunctionalTableData/raw/master/Images/Example1.png" />
<img src="https://github.com/Shopify/FunctionalTableData/raw/main/Images/Example1.png" />

### Building new Cells
Knowing that a cell consists of a view and state let's start with a simple example, a cell that displays a label. By specifying the generic requirements of `HostCell`, the simplest possible example is one that takes an `UILabel` as its view, a `String` as its state and `LayoutMarginsTableItemLayout` as the layout (See `TableItemLayout` for more info).
Expand Down Expand Up @@ -129,4 +129,4 @@ At the end of the day `HostCell` is just one of the possible implementations of
Seen other articles in the wild? Feel free to open a [pull request](https://github.com/Shopify/FunctionalTableData/pulls).

## License
Functional Table Data is under the [MIT License](https://github.com/Shopify/FunctionalTableData/blob/master/LICENSE.txt)
Functional Table Data is under the [MIT License](https://github.com/Shopify/FunctionalTableData/blob/main/LICENSE.txt)
6 changes: 3 additions & 3 deletions docs/Classes.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

52 changes: 26 additions & 26 deletions docs/Classes/FunctionalCollectionData.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Classes/FunctionalCollectionData/KeyPath.html
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/master/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L25">Show on GitHub</a>
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L25">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -190,7 +190,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/master/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L27">Show on GitHub</a>
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L27">Show on GitHub</a>
</div>
</section>
</div>
Expand Down Expand Up @@ -219,7 +219,7 @@ <h4>Declaration</h4>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/shopify/FunctionalTableData/tree/master/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L34-L36">Show on GitHub</a>
<a href="https://github.com/shopify/FunctionalTableData/tree/main/Sources/FunctionalTableData/CollectionView/FunctionalCollectionData.swift#L34-L36">Show on GitHub</a>
</div>
</section>
</div>
Expand Down
Loading

0 comments on commit b4f7c99

Please sign in to comment.