++Made with ❤️ by Ryo Aoyama +
+ --- |Declarative|Component-Based|Non-Destructive| |:----------|:--------------|:--------------| |Provides a declarative design with power of diffing algorithm for building list UIs.|Declare component once, it can be reused regardless kind of the list element.|Solves the various problems by architecture and algorithm without destructing UIKit.| --Made with ❤️ by Ryo Aoyama -
- --- ## Introduction @@ -37,7 +37,7 @@ This make it painless to build and maintain the complex UIs. Uses [DifferenceKit](https://github.com/ra1028/DifferenceKit) which is highly optimized based on Paul Heckel's paper for diffing. Declarative design and diffing algorithm make your code more predictable, debugging easier and providing beautiful animations to users. -Our goal is similar to [IGListKit](https://github.com/Instagram/IGListKit) and [Epoxy](https://github.com/airbnb/epoxy), we respect those library as pioneers. +Our goal is similar to [Instagram/IGListKit](https://github.com/Instagram/IGListKit) and [airbnb/Epoxy](https://github.com/airbnb/epoxy), we respect those library as pioneers. --- @@ -75,7 +75,7 @@ renderer.render( #### Build for Development -```bash +```sh $ git clone https://github.com/ra1028/Carbon.git $ cd Carbon/ $ make setup @@ -134,7 +134,7 @@ ViewNode(HelloMessage(name: "Vincent")) `CellNode` is a node representing cell. Unlike in the ViewNode, this needs an `id` which `Hashable` type to identify from among a lot of cells. -The `id` is used to find the same component in the list data before and after changed, then calculate the following kind of diff. +The `id` is used to find the same component in the list data before and after changed, then calculate the all kind of diff. - deletes - inserts - moves @@ -154,7 +154,7 @@ CellNode(HelloMessage(name: "Jules")) `Section` has a header, a footer and a group of cells. A group of cells can be contains nil, then skipped rendering of it cell. -This also needs to specify `id` for identify from among multiple sections, then can be calculate the several kind of diff. +This also needs to specify `id` for identify from among multiple sections, then can be calculate the all kind of diff. - section deletes - section inserts - section moves @@ -246,6 +246,10 @@ renderer.render( ) ``` +
++Made with ❤️ by Ryo Aoyama +
+-Made with ❤️ by Ryo Aoyama -
-Uses DifferenceKit which is highly optimized based on Paul Heckel’s paper for diffing.
Declarative design and diffing algorithm make your code more predictable, debugging easier and providing beautiful animations to users.
Our goal is similar to IGListKit and Epoxy, we respect those library as pioneers.
+Our goal is similar to Instagram/IGListKit and airbnb/Epoxy, we respect those library as pioneers.
CellNode is a node representing cell.
Unlike in the ViewNode, this needs an id which Hashable type to identify from among a lot of cells.
-The id is used to find the same component in the list data before and after changed, then calculate the following kind of diff.
id is used to find the same component in the list data before and after changed, then calculate the all kind of diff.
Section has a header, a footer and a group of cells.
A group of cells can be contains nil, then skipped rendering of it cell.
-This also needs to specify id for identify from among multiple sections, then can be calculate the several kind of diff.
id for identify from among multiple sections, then can be calculate the all kind of diff.
You can add methods of Delegate, DataSource by inheriting each adapter.
-Furthermore, it can be customized the class of the elements(cell/header/footer) which becomes the container of component by setting it to config.
You can add methods of delegate, dataSource by subclassing each adapter.
class CustomTableViewdapter: UITableViewAdapter {
+ func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
+ return "Header title for section\(section)"
+ }
+}
+
+let renderer = Renderer(
+ adapter: CustomTableViewAdapter(),
+ updater: UITableViewUpdater()
+)
+Furthermore, it can be customized the class of the elements(cell/header/footer) which becomes the container of component by setting it to config.
let config = UITableViewAdapter.Config(
+ cellClass: CustomCell.self,
+ headerViewClass: CustomHeaderView.self,
+ footerViewClass: CustomFooterView.self
+)
+let adapter = UITableViewAdapter(config: config)
+Add the following to your Podfile:
use_frameworks!
-
-target 'TargetName' do
- pod 'Carbon'
-end
+pod 'Carbon'
Carthage
diff --git a/scripts/install_swiftlint.sh b/scripts/install_swiftlint.sh
deleted file mode 100755
index 75cb143..0000000
--- a/scripts/install_swiftlint.sh
+++ /dev/null
@@ -1,19 +0,0 @@
-#!/bin/bash
-
-set -e
-
-SWIFTLINT_PKG_PATH="/tmp/SwiftLint.pkg"
-SWIFTLINT_PKG_URL="https://github.com/realm/SwiftLint/releases/download/0.30.1/SwiftLint.pkg"
-
-wget --output-document=$SWIFTLINT_PKG_PATH $SWIFTLINT_PKG_URL
-
-if [ -f $SWIFTLINT_PKG_PATH ]; then
- echo "Installing SwiftLint package..."
- sudo installer -pkg $SWIFTLINT_PKG_PATH -target /
-else
- echo "Compiling SwiftLint from source..." &&
- git clone https://github.com/realm/SwiftLint.git /tmp/SwiftLint &&
- cd /tmp/SwiftLint &&
- git submodule update --init --recursive &&
- sudo make install
-fi
\ No newline at end of file