@legendapp/list 3.0.0-beta.9 → 3.0.0

package/CHANGELOG.md

@@ -1,7 +1,27 @@
-## 3.0.0 beta
+## 3.0.0
 
 - Feat: Web support
 - Breaking: Some of the maintainVisibleContentPosition behavior for preventing jumping while scrolling is now core behavior, and the behavior for maintaining scroll position when adding data is controlled by the prop, which is now disabled by default.
+- See https://legendapp.com/open-source/list/v3/migration/
+
+## 2.0.18
+- Improvement: KeyboardAvoidingLegendList now supports KeyboardGestureArea with improved interactive behavior
+
+## 2.0.17
+- Feat: Add stickyHeaderOffset property to control sticky header positioning
+- Feat: Add sticky header backdrop component support
+- Fix: Improve KeyboardAvoidingLegendList quality by using animated contentOffset y instead of reanimated scrollTo
+- Fix: Initial scroll could sometimes be out of range beyond the ScrollView if some items are much larger than the estimated size
+- Fix: Item layout updates now work correctly when container is the exact same size as previous item on old arch
+
+## 2.0.16
+- Feat: Add KeyboardAvoidingLegendList component for better keyboard handling integration
+- Fix: Stale containers are not being removed and overlap with new data when using getItemType #335
+- Fix: Suppress keyExtractor warning when using lazy list mode #330
+
+## 2.0.15
+- Fix: Container allocation for sticky headers could duplicate containers, causing rendering issues
+- Fix: Sticky positioned components scrolling out of viewport after scrolling distance exceeded 5000
 
 ## 2.0.14
 - Feat: Add dataVersion prop to trigger re-render when mutating the data array in place

package/README.md

@@ -26,7 +26,8 @@ Beyond standard `FlatList` capabilities:
 *   `recycleItems`: (boolean) Toggles item component recycling.
     *   `true`: Reuses item components for optimal performance. Be cautious if your item components contain local state, as it might be reused unexpectedly.
     *   `false` (default): Creates new item components every time. Less performant but safer if items have complex internal state.
-*   `maintainScrollAtEnd`: (boolean) If `true` and the user is scrolled near the bottom (within `maintainScrollAtEndThreshold * screen height`), the list automatically scrolls to the end when items are added or heights change. Useful for chat interfaces.
+*   `maintainScrollAtEnd`: Keeps the list pinned to the tail when the user is already near the end (within `maintainScrollAtEndThreshold * screen height`). Pass `true` for all triggers, or `{ animated?: boolean, on?: { dataChange?: boolean, layout?: boolean, itemLayout?: boolean } }`; if `on` is omitted, the object form also enables all triggers.
+*   `maintainVisibleContentPosition`: Keeps visible content steady during size/layout changes while scrolling up or when items resize above the viewport (default). Pass `true` or `{ data: true }` to also anchor during data updates; pass `false` to disable; pass `{ size: false }` to opt out of scroll-time stabilization.
 *   `alignItemsAtEnd`: (boolean) Useful for chat UIs, content smaller than the View will be aligned to the bottom of the list.
 
 ---
@@ -54,11 +55,16 @@ npm install @legendapp/list
 yarn add @legendapp/list
 ```
 
+### Typed Imports
+
+- React Native: `@legendapp/list/react-native`
+- React: `@legendapp/list/react`
+
 ### Example
 ```tsx
 import React, { useRef } from "react"
 import { View, Image, Text, StyleSheet } from "react-native"
-import { LegendList, LegendListRef, LegendListRenderItemProps } from "@legendapp/list"
+import { LegendList, LegendListRef, LegendListRenderItemProps } from "@legendapp/list/react-native"
 
 // Define the type for your data items
 interface UserData {