Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix references of ASViewController/ASNavigationController (non-existent) to ASDKViewController/ASDKNavigationController #2072

Merged
merged 3 commits into from
Apr 5, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Also update ASNavigationController -> ASDKNavigationController
  • Loading branch information
JoeFerrucci committed Jan 23, 2023
commit 7524507308e1b7e0135eb42a40320a636cc02dcc
4 changes: 2 additions & 2 deletions docs/_docs/asvisibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ prevPage: debug-tool-ASRangeController.html
nextPage: asrunloopqueue.html
---

`ASNavigationController` and `ASTabBarController` both implement the `ASVisibility` protocol. These classes can be used even without `ASDisplayNodes`, making them suitable base classes for your inheritance hierarchy. For any child view controllers that are <a href="containers-asdkviewcontroller.html">`ASDKViewControllers`</a>, these classes know the exact number of user taps it would take to make the view controller visible (0 if currently visible).
`ASDKNavigationController` and `ASTabBarController` both implement the `ASVisibility` protocol. These classes can be used even without `ASDisplayNodes`, making them suitable base classes for your inheritance hierarchy. For any child view controllers that are <a href="containers-asdkviewcontroller.html">`ASDKViewControllers`</a>, these classes know the exact number of user taps it would take to make the view controller visible (0 if currently visible).

Knowing a view controller’s visibility depth allows view controllers to automatically take appropriate actions as a user approaches or leaves them. Non-default tabs in an app might preload some of their data; a controller 3 levels deep in a navigation stack might progressively free memory for images, text, and fetched data as it gets deeper.

Any container view controller can implement a simple protocol to integrate with the system. For example, `ASNavigationController` will return a visibility depth of it's own `visibilityDepth` + 1 for a view controller that would be revealed by tapping the back button once.
Any container view controller can implement a simple protocol to integrate with the system. For example, `ASDKNavigationController` will return a visibility depth of it's own `visibilityDepth` + 1 for a view controller that would be revealed by tapping the back button once.

You can opt into some of this behavior automatically by enabling `automaticallyAdjustRangeModeBasedOnViewEvents` on `ASDKViewController`s. With this enabled, if either the view controller or its node conform to `ASRangeControllerUpdateRangeProtocol` (`ASCollectionNode` and `ASTableNode` do by default), the ranges will automatically be decreased as the visibility depth increases to save memory.
2 changes: 1 addition & 1 deletion docs/_docs/containers-asdkviewcontroller.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ An `ASDKViewController` can be used in place of any `UIViewController` - includi
Benefits of using an `ASDKViewController`:
<ol>
<li><b>Save Memory</b>. An <code>ASDKViewController</code> that goes off screen will automatically reduce the size of the <a href="intelligent-preloading.html">fetch data</a> and <a href="intelligent-preloading.html">display ranges</a> of any of its children. This is key for memory management in large applications. </li>
<li><b><a href="asvisibility.html"><code>ASVisibility</code></a> Feature</b>. When used in an <code>ASNavigationController</code> or <code>ASTabBarController</code>, these classes know the exact number of user taps it would take to make the view controller visible.</li>
<li><b><a href="asvisibility.html"><code>ASVisibility</code></a> Feature</b>. When used in an <code>ASDKNavigationController</code> or <code>ASTabBarController</code>, these classes know the exact number of user taps it would take to make the view controller visible.</li>
</ol>

More features will be added over time, so it is a good idea to base your view controllers off of this class.
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/containers-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is highly recommended that you use Texture's nodes within a node container. T
<td>in place of UIKit's <code>UIViewController</code></td>
</tr>
<tr>
<td><code>ASNavigationController</code></td>
<td><code>ASDKNavigationController</code></td>
<td>in place of UIKit's <code>UINavigationController</code>. Implements the <a href = "asvisibility.html"><code>ASVisibility</code></a> protocol.</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/development/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here are the main directories within the repository:
- [Private](https://github.com/TextureGroup/Texture/tree/master/Source/Private): Framework-private files that are not exposed to end users, including implementation details, private data structures and helpers.
- [TextKit](https://github.com/TextureGroup/Texture/tree/master/Source/TextKit): All files related to TextKit that are used by ASTextNode.
- [tvOS](https://github.com/TextureGroup/Texture/tree/master/Source/tvOS): tvOS support.
- All other files in the [Source](https://github.com/TextureGroup/Texture/tree/master/Source) directory: Main files, including important components such as nodes (e.g ASDisplayNode, ASButtonNode, ASImageNode, ASCollectionNode and ASTableNode), ASNavigationController, etc.
- All other files in the [Source](https://github.com/TextureGroup/Texture/tree/master/Source) directory: Main files, including important components such as nodes (e.g ASDisplayNode, ASButtonNode, ASImageNode, ASCollectionNode and ASTableNode), ASDKNavigationController, etc.
- [Tests](https://github.com/TextureGroup/Texture/tree/master/Tests): The framework's test suite, including unit, integration and snapshot test cases.
- [docs](https://github.com/TextureGroup/Texture/tree/master/docs): Texture documentation that powers [texturegroup.org](https://texturegroup.org/).
- [examples](https://github.com/TextureGroup/Texture/tree/master/examples): Sample projects which demonstrate how to use various features of the framework.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">

<title>ASNavigationController Class Reference</title>
<title>ASDKNavigationController Class Reference</title>

<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
Expand Down Expand Up @@ -69,7 +69,7 @@ <h1 id="library-title">
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASNavigationController Class Reference</h1>
<h1 class="title">ASDKNavigationController Class Reference</h1>


<div class="section section-specification"><table cellspacing="0"><tbody>
Expand All @@ -81,7 +81,7 @@ <h1 class="title">ASNavigationController Class Reference</h1>
<td><a href="../Protocols/ASManagesChildVisibilityDepth.html">ASManagesChildVisibilityDepth</a></td>
</tr><tr>
<th>Declared in</th>
<td>ASNavigationController.h</td>
<td>ASDKNavigationController.h</td>
</tr>
</tbody></table></div>

Expand All @@ -91,9 +91,9 @@ <h1 class="title">ASNavigationController Class Reference</h1>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>ASNavigationController</p><p>ASNavigationController is a drop in replacement for UINavigationController
<p>ASDKNavigationController</p><p>ASDKNavigationController is a drop in replacement for UINavigationController
which improves memory efficiency by implementing the @c ASManagesChildVisibilityDepth protocol.
You can use ASNavigationController with regular UIViewControllers, as well as ASDKViewControllers.
You can use ASDKNavigationController with regular UIViewControllers, as well as ASDKViewControllers.
It is safe to subclass or use even where AsyncDisplayKit is not adopted.</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/appledoc/Protocols/ASManagesChildVisibilityDepth.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h3 class="method-title"><code><a href="#//api/name/visibilityDepthOfChildViewCo

<div class="method-subsection brief-description">
<p>Container view controllers should adopt this protocol to indicate that they will manage their child&rsquo;s
visibilityDepth. For example, ASNavigationController adopts this protocol and manages its childrens visibility
visibilityDepth. For example, ASDKNavigationController adopts this protocol and manages its childrens visibility
depth.</p>

<p>If you adopt this protocol, you <em>must</em> also emit visibilityDepthDidChange messages to child view controllers.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/appledoc/Protocols/ASVisibilityDepth.html
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ <h4 class="method-subtitle">Discussion</h4>
has changed.</p>

<p>If implemented by a view controller container, use this method to notify child view controllers that their view
depth has changed @see ASNavigationController.m</p>
depth has changed @see ASDKNavigationController.m</p>

<p>If implemented on an ASDKViewController, use this method to reduce or increase the resources that your
view controller uses. A higher visibility depth view controller should decrease it&rsquo;s resource usage, a lower
Expand Down
2 changes: 1 addition & 1 deletion docs/appledoc/hierarchy.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h2 class="index-title">Class Hierarchy</h2>
<li>UINavigationController
<ul>

<li><a href="Classes/ASNavigationController.html">ASNavigationController</a></li>
<li><a href="Classes/ASDKNavigationController.html">ASDKNavigationController</a></li>

</ul>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/appledoc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h2 class="index-title">Class References</h2>

<li><a href="Classes/ASMultiplexImageNode.html">ASMultiplexImageNode</a></li>

<li><a href="Classes/ASNavigationController.html">ASNavigationController</a></li>
<li><a href="Classes/ASDKNavigationController.html">ASDKNavigationController</a></li>

<li><a href="Classes/ASNetworkImageNode.html">ASNetworkImageNode</a></li>

Expand Down