AsyncDisplayKit README

The project's README from github.com/facebookarchive/AsyncDisplayKit. As one markdown file: README.md.

AsyncDisplayKit has been moved and renamed: Texture

Texture Logo

Learn more here





































AsyncDisplayKit

Apps Using Downloads

Platform Languages

Version Carthage compatible License

Installation

ASDK is available via CocoaPods or Carthage. See our Installation guide for instructions.

Performance Gains

AsyncDisplayKit's basic unit is the node. An ASDisplayNode is an abstraction over UIView, which in turn is an abstraction over CALayer. Unlike views, which can only be used on the main thread, nodes are thread-safe: you can instantiate and configure entire hierarchies of them in parallel on background threads.

To keep its user interface smooth and responsive, your app should render at 60 frames per second — the gold standard on iOS. This means the main thread has one-sixtieth of a second to push each frame. That's 16 milliseconds to execute all layout and drawing code! And because of system overhead, your code usually has less than ten milliseconds to run before it causes a frame drop.

AsyncDisplayKit lets you move image decoding, text sizing and rendering, layout, and other expensive UI operations off the main thread, to keep the main thread available to respond to user interaction.

Advanced Developer Features

As the framework has grown, many features have been added that can save developers tons of time by eliminating common boilerplate style structures common in modern iOS apps. If you've ever dealt with cell reuse bugs, tried to performantly preload data for a page or scroll style interface or even just tried to keep your app from dropping too many frames you can benefit from integrating ASDK.

Learn More

Getting Help

We use Slack for real-time debugging, community updates, and general talk about ASDK. Signup yourself or email AsyncDisplayKit(at)gmail.com to get an invite.

Contributing

We welcome any contributions. See the CONTRIBUTING file for how to get involved.

License

AsyncDisplayKit is BSD-licensed. We also provide an additional patent grant. The files in the /examples directory are licensed under a separate license as specified in each file; documentation is licensed CC-BY-4.0.

AsyncDisplayKit (facebookarchive/AsyncDisplayKit)

Searching Database…

13.3K ·GitHub
archived
What is this?AsyncDisplayKit (ASDK) is an iOS framework for smooth asynchronous user interfaces: it moves expensive UI work — image decoding, text sizing and rendering, layout — off the main thread so the app keeps responding to the user.
Is it a framework or a library, and what's the core idea?It's a framework built around the node: an ASDisplayNode is an abstraction over UIView, which in turn abstracts CALayer. Unlike views, nodes are thread-safe, so you can instantiate and configure whole hierarchies on background threads.
How do I add it to my app?Through CocoaPods or Carthage — the README links to an Installation guide with step-by-step instructions.
Should I start a new project with it today?Careful: the repository is archived and the README opens by saying AsyncDisplayKit has been moved and renamed, so track down its new home before adopting it.
What kind of apps benefit from it most?Scroll- or page-style interfaces that preload data, screens fighting cell reuse bugs, and any app dropping frames — the README says developers dealing with that boilerplate can benefit from integrating ASDK.
Is it free to use in a commercial app?Yes — BSD-licensed with an additional patent grant. Files in /examples carry their own licenses, and the documentation is CC-BY-4.0.
How tight is the frame budget it fights against?At the 60 fps gold standard the main thread gets about 16 milliseconds per frame — usually under ten after system overhead. Anything slower and the app drops frames, which is exactly what ASDK is built to prevent.
What learning materials ship with it?A Getting Started guide, sample projects you can download, and a full API reference. The samples live in the repo's /examples directory, which is licensed separately from the BSD-licensed framework code.
Size
128 MB
Stars
13.3K
Age
12y
Commits · 90 Days