Document ListView.DataSource facebook#410

Summary:Fixes facebook#410 Closes facebook#7193 Differential Revision: D3217718 fb-gh-sync-id: c05c9e3d67863c064f8e1102090614c6ba7e3127 fbshipit-source-id: c05c9e3d67863c064f8e1102090614c6ba7e3127
iodine · Aug 23, 2016 · 975133d · 975133d
1 parent ebc7924
commit 975133d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/Libraries/CustomComponents/ListView/ListView.js b/Libraries/CustomComponents/ListView/ListView.js
@@ -56,10 +56,10 @@ var DEFAULT_SCROLL_CALLBACK_THROTTLE = 50;
 /**
  * ListView - A core component designed for efficient display of vertically
  * scrolling lists of changing data.  The minimal API is to create a
- * `ListView.DataSource`, populate it with a simple array of data blobs, and
- * instantiate a `ListView` component with that data source and a `renderRow`
- * callback which takes a blob from the data array and returns a renderable
- * component.
+ * [`ListView.DataSource`](docs/listviewdatasource.html), populate it with a simple
+ * array of data blobs, and instantiate a `ListView` component with that data
+ * source and a `renderRow` callback which takes a blob from the data array and
+ * returns a renderable component.
  *
  * Minimal example:
  *
@@ -117,7 +117,9 @@ var ListView = React.createClass({
    */
   propTypes: {
     ...ScrollView.propTypes,
-
+    /**
+     * An instance of [ListView.DataSource](docs/listviewdatasource.html) to use
+     */
     dataSource: PropTypes.instanceOf(ListViewDataSource).isRequired,
     /**
      * (sectionID, rowID, adjacentRowHighlighted) => renderable

diff --git a/website/server/extractDocs.js b/website/server/extractDocs.js
@@ -107,12 +107,13 @@ function isRunnable(componentName, componentPlatform) {
 
 // Hide a component from the sidebar by making it return false from
 // this function
-function shouldDisplayInSidebar(componentName) {
-  if (componentName === 'Transforms') {
-    return false;
-  }
+var HIDDEN_COMPONENTS = [
+  'Transforms',
+  'ListViewDataSource',
+];
 
-  return true;
+function shouldDisplayInSidebar(componentName) {
+  return HIDDEN_COMPONENTS.indexOf(componentName) === -1;
 }
 
 function getNextComponent(i) {
@@ -271,6 +272,7 @@ var apis = [
   '../Libraries/LayoutAnimation/LayoutAnimation.js',
   '../Libraries/Linking/Linking.js',
   '../Libraries/LinkingIOS/LinkingIOS.js',
+  '../Libraries/CustomComponents/ListView/ListViewDataSource.js',
   '../node_modules/react/lib/NativeMethodsMixin.js',
   '../Libraries/Network/NetInfo.js',
   '../node_modules/react/lib/PanResponder.js',