Huy Nguyen 7d365c7d07 Introduce ASCollectionLayout and friends (#3130)
* Introduce ASCollectionViewLayout
- `ASCollectionViewLayout` is an async `UICollectionViewLayout` that encapsulates its layout calculation logic into a separate thread-safe object which can be used ahead of time and/or on multiple threads.
- `ASDataController` now can prepare for a new layout resulted from a change set before `ASCollectionView` even knows about it. By the time the change set it ready to be consumed by `ASCollectionView`, its new layout is also ready.
- New `ASCollectionViewLayoutCalculating` protocol that is simple and generic enough that many types of calculators can be built on top. `ASCollectionViewLayoutSpecCalculator` conforms to `ASCollectionViewLayoutCalculating` protocol and can be backed by any layout spec (e.g `ASStackLayoutSpec`, `PIMasonryLayoutSpec`, etc). We can even build a `ASCollectionViewLayoutYogaCalculator` that uses Yoga internally.
- A built-in `ASCollectionViewFlowLayoutCalculator` that is a subclass of `ASCollectionViewLayoutSpecCalculator` and uses a multi-threaded multi-line `ASStackLayoutSpec` internally. The result is a performant and thread-safe flow layout calculator.
- Finally, `ASCollectionViewLayout` can be subclassed to handle a specific type of calculator with optimizations implemented based on the knowledge of such calculator. For example, `ASCollectionViewFlowLayout` can have a highly optimized implementation of `-layoutAttributesForElementsInRect:`.

Protocolize layout calculator providing and consuming

Add flex wrap documentation

Add a `multithreaded` flag to ASStackLayoutSpec that forces it to dispatch even if it's off main
- Update ASCollectionViewFlowLayoutSpecCalculator to use that flag.

Minor change in ASCollectionViewLayout

Implement Mosaic layout calculator

Minor change

Fix project file

Rename and fix project file

Skip fetching constrained size only if a layout calculator is available

Update examples/ASCollectionView

Remove unnecessary change in ASTableView

Address comments

Rename collection view calculator protocols

Minor changes after rebasing with master

Add ASLegacyCollectionLayoutCalculator for backward compatibility

Remove ASCollectionLayoutSpecCalculator

Remove ASLegacyCollectionLayoutCalculator

Introduce ASCollectionLayout
- A wrapper object that contains content size and an element to rect table.
- Collection layout calculators to return this new object instead of an ASLayout.

Before adding a content cache

Finishing hooking up ASCollectionLayoutDataSource to ASCollectionNode

Stash

Finish ASCollectionLayout

Rough impl of ASCollectionFlowLayout

Revert changes in CustomCollectionView example

Move ASRectTable back to Private

* Rename ASCollectionContentAttributes to ASCollectionLayoutState

* Address other comments

* Introduce ASCollectionLayoutDelegate and make ASCollectionLayout private

* Address comments

* API tweaks:
- Replace `-layoutContextWithElementMap:` in ASCollectionLayoutDelegate with `-additionalInfoForLayoutWithElements:`. The returned object is then stored in ASCollectionLayoutContext for later lookups.
- ASCollectionLayoutContext has no public initializer.
- ASDataControllerLayoutDelegate no longer requires a context of type ASCollectionLayoutContext but simply an `id`. This helps decouple ASDataController and ASCollectionLayout.
- Rename `elementMap` to `elements`.
- Rename `visibleMap` to `visibleElements`.
- Other minor changes.

* Rename ASCGSizeHash to ASHashFromCGSize

* Make sure to call super in -[ASCollectionLayout prepareLayout]

* Update example/ASCollectionView to use ASCollectionFlowLayoutDelegate

* Remove unnecessary change
2017-04-12 11:13:44 +01:00
..
2017-02-01 14:40:37 -08:00
2017-02-14 14:10:51 -08:00

Sample projects

Building

Run pod install in each sample project directory to set up their dependencies.

Example Catalog

ASCollectionView [ObjC]

ASCollectionView Example App Screenshot

Featuring:

  • ASCollectionView with header/footer supplementary node support
  • ASCollectionView batch API
  • ASDelegateProxy

ASDKgram [ObjC]

ASDKgram Example App Screenshot

ASDKLayoutTransition [ObjC]

ASDKLayoutTransition Example App

ASDKTube [ObjC]

ASDKTube Example App

ASMapNode [ObjC]

ASMapNode Example App Screenshot

ASTableViewStressTest [ObjC]

ASTableViewStressTest Example App Screenshot

ASViewController [ObjC]

ASViewController Example App Screenshot

Featuring:

  • ASViewController
  • ASTableView
  • ASMultiplexImageNode
  • ASLayoutSpec

AsyncDisplayKitOverview [ObjC]

AsyncDisplayKitOverview Example App Screenshot

BackgroundPropertySetting [Swift]

BackgroundPropertySetting Example App gif

Featuring:

  • ASDK Swift compatibility
  • ASViewController
  • ASCollectionView
  • thread affinity
  • ASLayoutSpec

CarthageBuildTest

CatDealsCollectionView [ObjC]

CatDealsCollectionView Example App Screenshot

Featuring:

  • ASCollectionView
  • ASRangeTuningParameters
  • Placeholder Images
  • ASLayoutSpec

CollectionViewWithViewControllerCells [ObjC]

CollectionViewWithViewControllerCells Example App Screenshot

Featuring:

  • custom collection view layout
  • ASLayoutSpec
  • ASMultiplexImageNode

CustomCollectionView [ObjC+Swift]

CustomCollectionView Example App gif

Featuring:

  • custom collection view layout
  • ASCollectionView with sections

EditableText [ObjC]

EditableText Example App Screenshot

Featuring:

  • ASEditableTextNode

HorizontalwithinVerticalScrolling [ObjC]

HorizontalwithinVerticalScrolling Example App gif

Featuring:

  • UIViewController with ASTableView
  • ASCollectionView
  • ASCellNode

Kittens [ObjC]

Kittens Example App Screenshot

Featuring:

  • UIViewController with ASTableView
  • ASCellNodes with ASNetworkImageNode and ASTextNode

LayoutSpecPlayground [ObjC]

LayoutSpecPlayground Example App Screenshot

Multiplex [ObjC]

Multiplex Example App

Featuring:

  • ASMultiplexImageNode (with artificial delay inserted)
  • ASLayoutSpec

PagerNode [ObjC]

PagerNode Example App

Featuring:

  • ASPagerNode

Placeholders [ObjC]

Featuring:

  • ASDisplayNodes now have an overidable method -placeholderImage that lets you provide a custom UIImage to display while a node is displaying asyncronously. The default implementation of this method returns nil and thus does nothing. A provided example project also demonstrates using the placeholder API.

SocialAppLayout [ObjC]

SocialAppLayout Example App Screenshot

Featuring:

  • ASLayoutSpec
  • UIViewController with ASTableView

Swift [Swift]

Swift Example App Screenshot

Featuring:

  • ASViewController with ASTableNode

SynchronousConcurrency [ObjC]

SynchronousConcurrency Example App Screenshot

Implementation of Synchronous Concurrency features for AsyncDisplayKit 2.0

This provides internal features on _ASAsyncTransaction and ASDisplayNode to facilitate implementing public API that allows clients to choose if they would prefer to block on the completion of unfinished rendering, rather than allow a placeholder state to become visible.

The internal features are: -[_ASAsyncTransaction waitUntilComplete] -[ASDisplayNode recursivelyEnsureDisplay]

Also provided are two such implementations: -[ASCellNode setNeverShowPlaceholders:], which integrates with both Tables and Collections -[ASViewController setNeverShowPlaceholders:], which should work with Nav and Tab controllers.

Lastly, on ASDisplayNode, a new property .shouldBypassEnsureDisplay allows individual node types to exempt themselves from blocking the main thread on their display.

By implementing the feature at the ASCellNode level rather than ASTableView & ASCollectionView, developers can retain fine-grained control on display characteristics. For example, certain cell types may be appropriate to display to the user with placeholders, whereas others may not.

SynchronousKittens [ObjC]

VerticalWithinHorizontalScrolling [ObjC]

VerticalWithinHorizontalScrolling Example App

Features:

  • UIViewController containing ASPagerNode containing ASTableNodes

Videos [ObjC]

VideoTableView Example App gif

Featuring:

  • ASVideoNode

VideoTableView [ObjC]

VideoTableView Example App Screenshot

Featuring:

  • ASVideoNode
  • ASTableView
  • ASCellNode

License

This file provided by Facebook is for non-commercial testing and evaluation
purposes only.  Facebook reserves all rights not expressly granted.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.