mirror of
https://github.com/tappollo/IGListKit.git
synced 2026-05-28 06:26:04 +08:00
Regen docs for 2.0 release. Close #181
Summary: Closes #181 Closes https://github.com/Instagram/IGListKit/pull/207 Differential Revision: D4216383 Pulled By: jessesquires fbshipit-source-id: 664c6d0f1cf82647cf8e2231cf35348b08351c9d
This commit is contained in:
Jesse Squires
committed by
Facebook Github Bot
Facebook Github Bot
parent
b0e6070861
commit
cb45684e4d
@@ -13,7 +13,7 @@
|
||||
<a title="Protocols Reference"></a>
|
||||
<header>
|
||||
<div class="content-wrapper">
|
||||
<p><a href="index.html">IGListKit Docs</a> (79% documented)</p>
|
||||
<p><a href="index.html">IGListKit Docs</a> (100% documented)</p>
|
||||
<p class="header-right"><a href="https://github.com/Instagram/IGListKit"><img src="img/gh.png"/>View on GitHub</a></p>
|
||||
</div>
|
||||
</header>
|
||||
@@ -48,7 +48,7 @@
|
||||
<a href="Classes/IGListBatchUpdateData.html">IGListBatchUpdateData</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/IGListCollectionView.html">IGListCollectionView</a>
|
||||
<a href="Classes.html#/c:objc(cs)IGListCollectionView">IGListCollectionView</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Classes/IGListIndexPathResult.html">IGListIndexPathResult</a>
|
||||
@@ -151,6 +151,12 @@
|
||||
<li class="nav-group-task">
|
||||
<a href="Type Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListReloadUpdateBlock">IGListReloadUpdateBlock</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellConfigureBlock">IGListSingleSectionCellConfigureBlock</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Type Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellSizeBlock">IGListSingleSectionCellSizeBlock</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a href="Type Definitions.html#/c:IGListAdapter.h@T@IGListUpdaterCompletion">IGListUpdaterCompletion</a>
|
||||
</li>
|
||||
@@ -204,7 +210,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Implement this protocol to provide data to power an IGListAdapter feed.</p>
|
||||
<p>Implement this protocol to provide data to an <code><a href="Classes/IGListAdapter.html">IGListAdapter</a></code>.</p>
|
||||
|
||||
<a href="Protocols/IGListAdapterDataSource.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -241,10 +247,23 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>Conform to <code>IGListAdapterDelegate</code> to receive display events for objects in a list.</p>
|
||||
|
||||
<a href="Protocols/IGListAdapterDelegate.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
<div class="declaration">
|
||||
<h4>Declaration</h4>
|
||||
<div class="language">
|
||||
<p class="aside-title">Objective-C</p>
|
||||
<pre class="highlight"><code><span class="k">@protocol</span> <span class="nc">IGListAdapterDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
|
||||
|
||||
</div>
|
||||
<div class="language">
|
||||
<p class="aside-title">Swift</p>
|
||||
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">IGListAdapterDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
</li>
|
||||
@@ -265,7 +284,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>A protocol that receives events about IGListAdapterUpdater operations.</p>
|
||||
<p>A protocol that receives events about <code><a href="Classes/IGListAdapterUpdater.html">IGListAdapterUpdater</a></code> operations.</p>
|
||||
|
||||
<a href="Protocols/IGListAdapterUpdaterDelegate.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -302,8 +321,8 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The collection context provides limited access to the collection related information that
|
||||
section controllers need for things like sizing, dequeing cells, insterting/deleting/reloading, etc.</p>
|
||||
<p>The collection context provides limited access to the collection-related information that
|
||||
section controllers need for operations like sizing, dequeing cells, insterting, deleting, reloading, etc.</p>
|
||||
|
||||
<a href="Protocols/IGListCollectionContext.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -340,8 +359,7 @@ section controllers need for things like sizing, dequeing cells, insterting/dele
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>The IGListDiffable protocol provides the base methods needed to compare the identity and equality of two objects using
|
||||
one of the IGKAlgorithm functions.</p>
|
||||
<p>The <code>IGListDiffable</code> protocol provides methods needed to compare the identity and equality of two objects.</p>
|
||||
|
||||
<a href="Protocols/IGListDiffable.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -452,17 +470,17 @@ one of the IGKAlgorithm functions.</p>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Implement this protocol in order to be used within the IGListKit data infrastructure and be registered for use in an
|
||||
IGListAdapter. An IGListSectionType conforming object represents a single instance of an object in a collection of
|
||||
<p>Implement this protocol in order to be used within the <code>IGListKit</code> data infrastructure and be registered for use in an
|
||||
<code><a href="Classes/IGListAdapter.html">IGListAdapter</a></code>. An <code>IGListSectionType</code> conforming object represents a single instance of an object in a collection of
|
||||
objects.</p>
|
||||
|
||||
<p>The infrastructure uses each IGListSectionType conforming object as a <q>view model</q> to populate and control cells as
|
||||
part of a section in a UICollectionView feed. IGListSectionType objects should be architected without knowledge of
|
||||
<q>global</q> state of the feed they are contained in.</p>
|
||||
<p>The infrastructure uses each <code>IGListSectionType</code> conforming object as a <q>view model</q> to populate and control cells as
|
||||
part of a section in a <code>UICollectionView</code>. <code>IGListSectionType</code> objects should be architected without knowledge of
|
||||
<q>global</q> state of the list in which they are contained.</p>
|
||||
|
||||
<p>Index paths are used as a convenience for communicating the section index to each section object without allowing each
|
||||
section to mutate its own position within a feed. The row of an index path can be directly mapped to a cell within
|
||||
an IGListSectionType conforming object.</p>
|
||||
section to mutate its own position within a list. The row of an index path can be directly mapped to a cell within
|
||||
an <code>IGListSectionType</code> conforming object.</p>
|
||||
|
||||
<a href="Protocols/IGListSectionType.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -499,7 +517,7 @@ an IGListSectionType conforming object.</p>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>A delegate that can receive selection events on an IGListSingleSectionController.</p>
|
||||
<p>A delegate that can receive selection events on an <code><a href="Classes/IGListSingleSectionController.html">IGListSingleSectionController</a></code>.</p>
|
||||
|
||||
<a href="Protocols/IGListSingleSectionControllerDelegate.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -536,9 +554,9 @@ an IGListSectionType conforming object.</p>
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Implement the methods of this protocol to provide information about a list’s supplementary views. This data is used in
|
||||
IGListAdapter which then configures and maintains a UICollectionView. The supplementary API reflects that in
|
||||
UICollectionView, UICollectionViewLayout, and UICollectionViewDataSource.</p>
|
||||
<p>Conform to this protocol to provide information about a list’s supplementary views. This data is used in
|
||||
<code><a href="Classes/IGListAdapter.html">IGListAdapter</a></code> which then configures and maintains a <code>UICollectionView</code>. The supplementary API reflects that in
|
||||
<code>UICollectionView</code>, <code>UICollectionViewLayout</code>, and <code>UICollectionViewDataSource</code>.</p>
|
||||
|
||||
<a href="Protocols/IGListSupplementaryViewSource.html" class="slightly-smaller">See more</a>
|
||||
</div>
|
||||
@@ -641,7 +659,7 @@ you could begin decoding images, or warming text caches.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="footer">
|
||||
<p>© 2016 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2016-09-30)</p>
|
||||
<p>© 2016 <a class="link" href="https://twitter.com/fbOpenSource" target="_blank" rel="external">Instagram</a>. All rights reserved. (Last updated: 2016-11-21)</p>
|
||||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||||
</section>
|
||||
</article>
|
||||
|
||||
Reference in New Issue
Block a user