Elgato_dark/IGListKit
1
0
Fork 0
mirror of https://github.com/Instagram/IGListKit synced 2026-04-21 21:47:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
IGListKit/docs/Protocols/IGListBindingSectionControllerDataSource.html

591 lines
32 KiB
HTML
Raw Normal View History

Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<title>IGListBindingSectionControllerDataSource Protocol Reference</title>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</head>
<body>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a name="//apple_ref/objc/Protocol/IGListBindingSectionControllerDataSource" class="dashAnchor"></a>
<a title="IGListBindingSectionControllerDataSource Protocol Reference"></a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<header>
<div class="content-wrapper">
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<p><a href="../index.html">IGListKit 5.2.0 Docs</a> (96% documented)</p>
Regenerate docs via jazzy Summary: I regenerated the documentation that lives at https://instagram.github.io/IGListKit/ via the `scripts/build_docs.sh` script. This updates the IGListKit documentation from 2021 to 2023, updating references to Meta's open source Twitter account, and ensuring the legally required copyright notices are visible. Differential Revision: D44751773 fbshipit-source-id: 61cc1b9501b1659eb7d4810ea85b80da25e5a69a
2023-04-07 07:23:43 +00:00
<p class="header-right"><a href="https://github.com/Instagram/IGListKit"><img src="../img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
Regenerate docs via jazzy Summary: I regenerated the documentation that lives at https://instagram.github.io/IGListKit/ via the `scripts/build_docs.sh` script. This updates the IGListKit documentation from 2021 to 2023, updating references to Meta's open source Twitter account, and ensuring the legally required copyright notices are visible. Differential Revision: D44751773 fbshipit-source-id: 61cc1b9501b1659eb7d4810ea85b80da25e5a69a
2023-04-07 07:23:43 +00:00
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
<a href="../index.html">IGListKit</a>
<img id="carat" src="../img/carat.png" alt=""/>
<a href="../Protocols.html">Protocols</a>
Regenerate docs via jazzy Summary: I regenerated the documentation that lives at https://instagram.github.io/IGListKit/ via the `scripts/build_docs.sh` script. This updates the IGListKit documentation from 2021 to 2023, updating references to Meta's open source Twitter account, and ensuring the legally required copyright notices are visible. Differential Revision: D44751773 fbshipit-source-id: 61cc1b9501b1659eb7d4810ea85b80da25e5a69a
2023-04-07 07:23:43 +00:00
<img id="carat" src="../img/carat.png" alt=""/>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
IGListBindingSectionControllerDataSource Protocol Reference
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
Initial setup for guides Summary: - Create `Guides/` top-level dir - Move `README` "creating first list" contents into `Guides/Getting Started.md` - Add initial `Guides/Migration.md` (ref #221) - Fix #245 See rendered guides at: - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md Closes https://github.com/Instagram/IGListKit/pull/252 Differential Revision: D4228332 Pulled By: jessesquires fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 20:42:52 +00:00
<li class="nav-group-name">
<a href="../Guides.html">Guides</a>
<ul class="nav-group-tasks">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<li class="nav-group-task">
<a href="../best-practices-and-faq.html">Best Practices and FAQ</a>
</li>
Generate docs for 3.3.0 Summary: Ran `build_docs.sh` script for 3.3.0 release Closes https://github.com/Instagram/IGListKit/pull/1154 Differential Revision: D7728775 Pulled By: rnystrom fbshipit-source-id: 40a77e95387050a8d7c6bc4a629fdb06b7b0a7fa
2018-04-23 16:27:43 +00:00
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../generating-your-models-using-remodel.html">Generating your models using remodel</a>
Generate docs for 3.3.0 Summary: Ran `build_docs.sh` script for 3.3.0 release Closes https://github.com/Instagram/IGListKit/pull/1154 Differential Revision: D7728775 Pulled By: rnystrom fbshipit-source-id: 40a77e95387050a8d7c6bc4a629fdb06b7b0a7fa
2018-04-23 16:27:43 +00:00
</li>
Initial setup for guides Summary: - Create `Guides/` top-level dir - Move `README` "creating first list" contents into `Guides/Getting Started.md` - Add initial `Guides/Migration.md` (ref #221) - Fix #245 See rendered guides at: - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md Closes https://github.com/Instagram/IGListKit/pull/252 Differential Revision: D4228332 Pulled By: jessesquires fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 20:42:52 +00:00
<li class="nav-group-task">
<a href="../getting-started.html">Getting Started</a>
</li>
re-gen docs Summary: Closes https://github.com/Instagram/IGListKit/pull/264 Differential Revision: D4235666 Pulled By: jessesquires fbshipit-source-id: 2adb3e5b656d112fe4f2c106721a5d4b9085337a
2016-11-28 00:53:20 +00:00
<li class="nav-group-task">
<a href="../iglistdiffable-and-equality.html">IGListDiffable and Equality</a>
</li>
Added Subspec for Diffing Summary: So the main Podspec file now has two Subspecs, `Diffing` and for lack of better name `Default`. `Diffing` is purely the files within the common directories (used for Diffing, if in the future we support MacOS NSCollectionView then this may need changing). `Default` depends on `Diffing` but also adds all the non-common files. To use it via CocoaPods, nothing changes. You `import IGListKit` and you will only have access to the files in the pod you use. (So if you use `IGListKit/Diffing` in your Podfile, then you will only get access to the diffing files). If you do a manual installation, or I assume via Carthage, then you will need to import the correct header file (either `IGListDiffKit.h` or `IGListKit.h` depending on what you want). Turns out CocoaPods creates it's own umbrella header (unless you tell it otherwise) meaning our ones are unused by it. Just to confirm `IGListKit` in your Podfile will give you everything, only if you add `/Diffing` will you "opt-out" o Closes https://github.com/Instagram/IGListKit/pull/368 Differential Revision: D4367438 Pulled By: jessesquires fbshipit-source-id: 272318ca551e7e8c4177ca3ca501fde23bd9705a
2016-12-27 20:37:57 +00:00
<li class="nav-group-task">
<a href="../installation.html">Installation</a>
</li>
Initial setup for guides Summary: - Create `Guides/` top-level dir - Move `README` "creating first list" contents into `Guides/Getting Started.md` - Add initial `Guides/Migration.md` (ref #221) - Fix #245 See rendered guides at: - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md Closes https://github.com/Instagram/IGListKit/pull/252 Differential Revision: D4228332 Pulled By: jessesquires fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 20:42:52 +00:00
<li class="nav-group-task">
<a href="../migration.html">Migration</a>
</li>
Regen documentation for 3.1.0 Summary: Preparing for 3.1.0 release, regen all documentation ⚠️ wait for #899, #908 to land, rebase, and regen ⚠️ Closes https://github.com/Instagram/IGListKit/pull/907 Differential Revision: D5691928 Pulled By: rnystrom fbshipit-source-id: 4e8a13c7b25bef2622c4212552a754d0f7d7da62
2017-08-23 21:12:05 +00:00
<li class="nav-group-task">
<a href="../modeling-and-binding.html">Modeling and Binding</a>
</li>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<li class="nav-group-task">
<a href="../vision.html">VISION</a>
</li>
<li class="nav-group-task">
<a href="../working-with-core-data.html">Working with Core Data</a>
</li>
<li class="nav-group-task">
<a href="../working-with-uicollectionview.html">Working with UICollectionView</a>
</li>
Initial setup for guides Summary: - Create `Guides/` top-level dir - Move `README` "creating first list" contents into `Guides/Getting Started.md` - Add initial `Guides/Migration.md` (ref #221) - Fix #245 See rendered guides at: - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md - https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md Closes https://github.com/Instagram/IGListKit/pull/252 Differential Revision: D4228332 Pulled By: jessesquires fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 20:42:52 +00:00
</ul>
</li>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<li class="nav-group-name">
<a href="../Categories.html">Categories</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Categories/UIViewController%28IGListAdapter%29.html">UIViewController(IGListAdapter)</a>
</li>
</ul>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/IGListAdapter.html">IGListAdapter</a>
</li>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListAdapterDelegateAnnouncer.html">IGListAdapterDelegateAnnouncer</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListAdapterUpdater.html">IGListAdapterUpdater</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListBatchUpdateData.html">IGListBatchUpdateData</a>
</li>
<li class="nav-group-task">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a>
</li>
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListBindingSingleSectionController.html">IGListBindingSingleSectionController</a>
</li>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListCollectionView.html">IGListCollectionView</a>
</li>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListCollectionViewLayout.html">IGListCollectionViewLayout</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListCollectionViewLayoutInvalidationContext.html">IGListCollectionViewLayoutInvalidationContext</a>
</li>
Cleanup layout Summary: Replaces #243 --------------------- - Clean up GridLayout + docs - Remove GridLayout scroll direction, not used/supported? - Fix some file target membership issues - Add GridLayout to umbrella header - "Sort by name" on xcode project directories - crtl-I auto format in xcode - re-gen docs Closes https://github.com/Instagram/IGListKit/pull/246 Differential Revision: D4219028 Pulled By: jessesquires fbshipit-source-id: 02d6d284c47dd4301549d9094727054156d596aa
2016-11-22 07:18:30 +00:00
<li class="nav-group-task">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a href="../Classes/IGListGenericSectionController.html">IGListGenericSectionController</a>
Cleanup layout Summary: Replaces #243 --------------------- - Clean up GridLayout + docs - Remove GridLayout scroll direction, not used/supported? - Fix some file target membership issues - Add GridLayout to umbrella header - "Sort by name" on xcode project directories - crtl-I auto format in xcode - re-gen docs Closes https://github.com/Instagram/IGListKit/pull/246 Differential Revision: D4219028 Pulled By: jessesquires fbshipit-source-id: 02d6d284c47dd4301549d9094727054156d596aa
2016-11-22 07:18:30 +00:00
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListIndexPathResult.html">IGListIndexPathResult</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListIndexSetResult.html">IGListIndexSetResult</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListMoveIndex.html">IGListMoveIndex</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListMoveIndexPath.html">IGListMoveIndexPath</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/c:objc(cs)IGListReloadDataUpdater">IGListReloadDataUpdater</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListSectionController.html">IGListSectionController</a>
</li>
<li class="nav-group-task">
<a href="../Classes/IGListSingleSectionController.html">IGListSingleSectionController</a>
</li>
Regenerate docs via jazzy Summary: I regenerated the documentation that lives at https://instagram.github.io/IGListKit/ via the `scripts/build_docs.sh` script. This updates the IGListKit documentation from 2021 to 2023, updating references to Meta's open source Twitter account, and ensuring the legally required copyright notices are visible. Differential Revision: D44751773 fbshipit-source-id: 61cc1b9501b1659eb7d4810ea85b80da25e5a69a
2023-04-07 07:23:43 +00:00
<li class="nav-group-task">
<a href="../Classes/IGListTransitionData.html">IGListTransitionData</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</ul>
</li>
<li class="nav-group-name">
<a href="../Constants.html">Constants</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Constants.html#/c:@IGListKitVersionNumber">IGListKitVersionNumber</a>
</li>
<li class="nav-group-task">
<a href="../Constants.html#/c:@IGListKitVersionString">IGListKitVersionString</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<a href="../Enums.html">Enumerations</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<ul class="nav-group-tasks">
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<li class="nav-group-task">
<a href="../Enums/IGListAdapterUpdateType.html">IGListAdapterUpdateType</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Enums/IGListDiffOption.html">IGListDiffOption</a>
</li>
<li class="nav-group-task">
<a href="../Enums/IGListExperiment.html">IGListExperiment</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterDataSource.html">IGListAdapterDataSource</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterDelegate.html">IGListAdapterDelegate</a>
</li>
Generate docs for 3.3.0 Summary: Ran `build_docs.sh` script for 3.3.0 release Closes https://github.com/Instagram/IGListKit/pull/1154 Differential Revision: D7728775 Pulled By: rnystrom fbshipit-source-id: 40a77e95387050a8d7c6bc4a629fdb06b7b0a7fa
2018-04-23 16:27:43 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterMoveDelegate.html">IGListAdapterMoveDelegate</a>
</li>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterPerformanceDelegate.html">IGListAdapterPerformanceDelegate</a>
</li>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterUpdateListener.html">IGListAdapterUpdateListener</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListAdapterUpdaterDelegate.html">IGListAdapterUpdaterDelegate</a>
</li>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListBatchContext.html">IGListBatchContext</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListBindable.html">IGListBindable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListBindingSectionControllerDataSource.html">IGListBindingSectionControllerDataSource</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListBindingSectionControllerSelectionDelegate.html">IGListBindingSectionControllerSelectionDelegate</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListCollectionContext.html">IGListCollectionContext</a>
</li>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListCollectionViewDelegateLayout.html">IGListCollectionViewDelegateLayout</a>
</li>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListCollectionViewLayoutCompatible.html">IGListCollectionViewLayoutCompatible</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListDiffable.html">IGListDiffable</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListDisplayDelegate.html">IGListDisplayDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListScrollDelegate.html">IGListScrollDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListSingleSectionControllerDelegate.html">IGListSingleSectionControllerDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListSupplementaryViewSource.html">IGListSupplementaryViewSource</a>
</li>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListTransitionDelegate.html">IGListTransitionDelegate</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
<a href="../Protocols/IGListUpdatingDelegate.html">IGListUpdatingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IGListWorkingRangeDelegate.html">IGListWorkingRangeDelegate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html">Type Definitions</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<ul class="nav-group-tasks">
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<li class="nav-group-task">
<a href="../Type%20Definitions/IGListAdaptiveCoalescingExperimentConfig.html">IGListAdaptiveCoalescingExperimentConfig</a>
</li>
<li class="nav-group-task">
<a href="../Type%20Definitions/IGListAdaptiveDiffingExperimentConfig.html">IGListAdaptiveDiffingExperimentConfig</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions/IGListCollectionScrollingTraits.html">IGListCollectionScrollingTraits</a>
</li>
<li class="nav-group-task">
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListCollectionViewBlock">IGListCollectionViewBlock</a>
</li>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<li class="nav-group-task">
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListDataSourceChangeBlock">IGListDataSourceChangeBlock</a>
</li>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<li class="nav-group-task">
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListItemUpdateBlock">IGListItemUpdateBlock</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListObjectTransitionBlock">IGListObjectTransitionBlock</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListReloadUpdateBlock">IGListReloadUpdateBlock</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
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
2016-11-21 23:36:26 +00:00
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellConfigureBlock">IGListSingleSectionCellConfigureBlock</a>
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
2016-11-21 23:36:26 +00:00
</li>
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListSingleSectionController.h@T@IGListSingleSectionCellSizeBlock">IGListSingleSectionCellSizeBlock</a>
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
2016-11-21 23:36:26 +00:00
</li>
Regenerate docs for 3.4 Summary: See title Closes https://github.com/Instagram/IGListKit/pull/1164 Differential Revision: D7838218 Pulled By: rnystrom fbshipit-source-id: f9e1aa63b5d3a846fc155bd010f6d17e27a1b1ab
2018-05-01 23:54:35 +00:00
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListToObjectBlock">IGListToObjectBlock</a>
Regenerate docs for 3.4 Summary: See title Closes https://github.com/Instagram/IGListKit/pull/1164 Differential Revision: D7838218 Pulled By: rnystrom fbshipit-source-id: f9e1aa63b5d3a846fc155bd010f6d17e27a1b1ab
2018-05-01 23:54:35 +00:00
</li>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<li class="nav-group-task">
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListTransitionDataApplyBlock">IGListTransitionDataApplyBlock</a>
</li>
<li class="nav-group-task">
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListTransitionDataBlock">IGListTransitionDataBlock</a>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListAdapter.h@T@IGListUpdaterCompletion">IGListUpdaterCompletion</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
<li class="nav-group-task">
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<a href="../Type%20Definitions.html#/c:IGListUpdatingDelegate.h@T@IGListUpdatingCompletion">IGListUpdatingCompletion</a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/c:@F@IGListDiff">IGListDiff</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/c:@F@IGListDiffPaths">IGListDiffPaths</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/c:IGListExperiments.h@F@IGListExperimentEnabled">IGListExperimentEnabled</a>
</li>
</ul>
</li>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<li class="nav-group-task">
<a href="../Structs/IGListAdaptiveCoalescingExperimentConfig.html">IGListAdaptiveCoalescingExperimentConfig</a>
</li>
<li class="nav-group-task">
<a href="../Structs/IGListAdaptiveDiffingExperimentConfig.html">IGListAdaptiveDiffingExperimentConfig</a>
</li>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<li class="nav-group-task">
<a href="../Structs/IGListCollectionScrollingTraits.html">IGListCollectionScrollingTraits</a>
</li>
</ul>
</li>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<h1>IGListBindingSectionControllerDataSource</h1>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<div class="declaration">
<div class="language">
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<p class="aside-title">Objective-C</p>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">IGListBindingSectionControllerDataSource</span> <span class="o">&lt;</span><span class="n">NSObject</span><span class="o">&gt;</span></code></pre>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<div class="language">
<p class="aside-title">Swift</p>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<pre class="highlight swift"><code><span class="kd">@MainActor</span> <span class="kd">protocol</span> <span class="kt">ListBindingSectionControllerDataSource</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>A protocol that returns data to power cells in an <code><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></code>.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a name="/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:viewModelsForObject:"></a>
<a name="//apple_ref/objc/Method/-sectionController:viewModelsForObject:" class="dashAnchor"></a>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<a class="token" href="#/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:viewModelsForObject:">-sectionController:<wbr>viewModelsForObject:<wbr></a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>Create an array of view models given a top-level object.</p>
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
2016-11-21 23:36:26 +00:00
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">id</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListDiffable.html">IGListDiffable</a></span><span class="o">&gt;&gt;</span> <span class="o">*</span><span class="p">)</span>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<span class="nf">sectionController</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">sectionController</span>
<span class="nf">viewModelsForObject</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span><span class="p">;</span></code></pre>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
<div class="language">
<p class="aside-title">Swift</p>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sectionController</span><span class="p">(</span><span class="n">_</span> <span class="nv">sectionController</span><span class="p">:</span> <span class="kt"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span><span class="p">,</span> <span class="n">viewModelsFor</span> <span class="nv">object</span><span class="p">:</span> <span class="kt">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="n">any</span> <span class="kt"><a href="../Protocols/IGListDiffable.html">IGListDiffable</a></span><span class="p">]</span></code></pre>
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<em>sectionController</em>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</code>
</td>
<td>
<div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>The section controller requesting view models.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>object</em>
</code>
</td>
<td>
<div>
<p>The top-level object that powers the section controller.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>A new array of view models.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a name="/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:cellForViewModel:atIndex:"></a>
<a name="//apple_ref/objc/Method/-sectionController:cellForViewModel:atIndex:" class="dashAnchor"></a>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<a class="token" href="#/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:cellForViewModel:atIndex:">-sectionController:<wbr>cellForViewModel:<wbr>atIndex:<wbr></a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>Return a dequeued cell for a given view model.</p>
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
2016-11-21 23:36:26 +00:00
<div class="aside aside-note">
<p class="aside-title">Note</p>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>The section controller will call <code>-bindViewModel:</code> with the provided view model after the cell is dequeued. You
should handle cell configuration using this method. However, you can do additional configuration at this stage as well.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00: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
2016-11-21 23:36:26 +00:00
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">UICollectionViewCell</span><span class="o">&lt;</span><span class="n"><a href="../Protocols/IGListBindable.html">IGListBindable</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<span class="nf">sectionController</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">sectionController</span>
<span class="nf">cellForViewModel</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="p">)</span><span class="nv">viewModel</span>
<span class="nf">atIndex</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">index</span><span class="p">;</span></code></pre>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
<div class="language">
<p class="aside-title">Swift</p>
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sectionController</span><span class="p">(</span><span class="n">_</span> <span class="nv">sectionController</span><span class="p">:</span> <span class="kt"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span><span class="p">,</span> <span class="n">cellForViewModel</span> <span class="nv">viewModel</span><span class="p">:</span> <span class="kt">Any</span><span class="p">,</span> <span class="n">at</span> <span class="nv">index</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">any</span> <span class="kt">UICollectionViewCell</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols/IGListBindable.html">IGListBindable</a></span></code></pre>
Regenerate IGListKit documentation via jazzy Summary: Regenerated the IGListKit documentation via jazzy. Reviewed By: fabiomassimo Differential Revision: D57263196 fbshipit-source-id: 1a649e29a4bfa0d12fa81d00f96ea9264a68f013
2024-05-13 04:14:35 +00:00
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<tr>
<td>
<code>
<em>sectionController</em>
</code>
</td>
<td>
<div>
<p>The section controller requesting a cell.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>viewModel</em>
</code>
</td>
<td>
<div>
<p>The view model for the cell.</p>
</div>
</td>
</tr>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
<tr>
<td>
<code>
<em>index</em>
</code>
</td>
<td>
<div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>The index of the view model.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>A dequeued cell.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<a name="/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:sizeForViewModel:atIndex:"></a>
<a name="//apple_ref/objc/Method/-sectionController:sizeForViewModel:atIndex:" class="dashAnchor"></a>
re-run doc build script Summary: As title, currently https://instagram.github.io/IGListKit/ is not working. Let's try to rebuild the doc Reviewed By: Ziewvater Differential Revision: D31811862 fbshipit-source-id: 8a0b0ce6c73542da71dddd13c24b5eb9fe9b0506
2021-10-28 22:47:52 +00:00
<a class="token" href="#/c:objc(pl)IGListBindingSectionControllerDataSource(im)sectionController:sizeForViewModel:atIndex:">-sectionController:<wbr>sizeForViewModel:<wbr>atIndex:<wbr></a>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>Return a cell size for a given view model.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Objective-C</p>
Generate 3.2 docs Summary: Does this need to wait for #1086? Closes https://github.com/Instagram/IGListKit/pull/1085 Differential Revision: D6917735 Pulled By: rnystrom fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 23:42:25 +00:00
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">CGSize</span><span class="p">)</span><span class="nf">sectionController</span><span class="p">:</span>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">sectionController</span>
<span class="nf">sizeForViewModel</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="p">)</span><span class="nv">viewModel</span>
<span class="nf">atIndex</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">index</span><span class="p">;</span></code></pre>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
<div class="language">
<p class="aside-title">Swift</p>
Fix the build_doc.sh and regenerate all the docs! (#1393) Summary: ## Changes in this pull request Get this fix and make it ready for 4.0 release. ### Checklist - [ ] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1393 Reviewed By: iperry90 Differential Revision: D18618773 Pulled By: lorixx fbshipit-source-id: 0360c36d85dc5db15d7e08bdf68ec9c8be992499
2019-11-21 00:20:23 +00:00
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sectionController</span><span class="p">(</span><span class="n">_</span> <span class="nv">sectionController</span><span class="p">:</span> <span class="kt"><a href="../Classes/IGListBindingSectionController.html">IGListBindingSectionController</a></span><span class="p">,</span> <span class="n">sizeForViewModel</span> <span class="nv">viewModel</span><span class="p">:</span> <span class="kt">Any</span><span class="p">,</span> <span class="n">at</span> <span class="nv">index</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">CGSize</span></code></pre>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<em>sectionController</em>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</code>
</td>
<td>
<div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>The section controller requesting a size.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>viewModel</em>
</code>
</td>
<td>
<div>
<p>The view model for the cell.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>index</em>
</code>
</td>
<td>
<div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<p>The index of the view model.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
Regen docs for 3.0 Summary: ~~Land after #661, #730 and D5031184~~ Rebuild the docs from script. Couple notes: - Went from 100% to 99%, does that matter? Script output says - > 99% documentation coverage with 2 undocumented symbols - Looks like `NS_SWIFT_NAME` throws documentation for a loop on `IGListDiffOption` and `IGListExperiment` - Swift names are different, will that be a problem? Part of #707 Closes https://github.com/Instagram/IGListKit/pull/728 Differential Revision: D5050951 Pulled By: jessesquires fbshipit-source-id: 19249c1d34e6f253b911965114fd4ae7458d2684
2017-05-12 14:19:12 +00:00
<div>
<h4>Return Value</h4>
<p>A size for the view model.</p>
</div>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
Updated the IGListKit docs to v5.2.0 (#1656) Summary: ## Changes in this pull request Updates the IGListKit docs to the latest API spec in v5.2.0 ### Checklist - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/main/.github/CONTRIBUTING.md) Pull Request resolved: https://github.com/instagram/IGListKit/pull/1656 Reviewed By: jurmarcus Differential Revision: D93350284 Pulled By: TimOliver fbshipit-source-id: fa4276caae7309f3ef0fd78f5a0c4bcc05d9cb9f
2026-02-17 07:54:31 +00:00
<p>&copy; 2026 <a class="link" href="https://twitter.com/MetaOpenSource" target="_blank" rel="external noopener">Instagram</a>. All rights reserved. (Last updated: 2026-02-15)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
Initial commit fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-09-07 22:37:59 +00:00
</section>
</article>
</div>
</body>
</html>
Reference in a new issue Copy permalink