[DF] feat(Shopify#547): update documentation

friyiajr · Mar 30, 2023 · e157b42 · e157b42
1 parent b34e8ef
commit e157b42
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/FlashList.tsx b/src/FlashList.tsx
@@ -505,6 +505,7 @@ class FlashList<T> extends React.PureComponent<
         }}
         index={parentProps.index}
         stableId={
+          /* Empty string is used so the list can still render without an extractor */
           this.props.keyExtractor?.(parentProps.data, parentProps.index) ?? ""
         }
       >

diff --git a/src/FlashListProps.ts b/src/FlashListProps.ts
@@ -335,8 +335,9 @@ export interface FlashListProps<TItem> extends ScrollViewProps {
 
   /**
    * If enabled, FlashList will try and maintain the position of the list when items are added from the top.
-   * This prop requires you define a `keyExtractor` function. The keyExtractor is used to compute the list
-   * top anchor. Without it, the list will fail to render.
+   * This prop requires you define a `keyExtractor` function. The `keyExtractor` is used to compute the list
+   * top anchor. Without it, the list will fail to render. If in debug mode, you may see flashes if new data
+   * comes in quickly. If this happens, please confirm you see this in release mode before reporting an issue.
    */
   experimentalMaintainTopContentPosition?: boolean;
 }