@legendapp/list 0.2.1 → 0.2.2

package/README.md

@@ -11,7 +11,7 @@ This is an early release to test and gather feedback. It's not used in productio
 In addition to normal FlatList features:
 
 -   Dynamic layouts supported. Just use the `estimatedItemLength` prop to give a close estimate so that layouts aren't too far off, and positions will adjust while rendering.
--   `autoScrollToBottom`: If true and scroll is within `autoScrollToBottomThreshold * screen height` then changing items or heights will scroll to the bottom. This can be useful for chat interfaces.
+-   `maintainScrollAtEnd`: If true and scroll is within `maintainScrollAtEndThreshold * screen height` then changing items or heights will scroll to the bottom. This can be useful for chat interfaces.
 -   `recycleItems` prop enables toggling recycling of list items. If enabled it will reuse item components for improved performance, but it will reuse any local state in items. So if you have local state in items you likely want this disabled.
 
 ## Usage
@@ -40,8 +40,8 @@ interface PropsOptional {
     initialContainers?: number;
     recycleItems?: boolean;
     onEndReachedThreshold?: number | null | undefined;
-    autoScrollToBottom?: boolean;
-    autoScrollToBottomThreshold?: number;
+    maintainScrollAtEnd?: boolean;
+    maintainScrollAtEndThreshold?: number;
     onEndReached?: ((info: { distanceFromEnd: number }) => void) | null | undefined;
     keyExtractor?: (item: T, index: number) => string;
     onViewableRangeChanged?: (range: ViewableRange<T>) => void;

package/index.d.mts

@@ -9,9 +9,9 @@ type LegendListProps<T> = Omit<ComponentProps<typeof ScrollView>, 'contentOffset
     initialContainers?: number;
     recycleItems?: boolean;
     onEndReachedThreshold?: number | null | undefined;
-    autoScrollToBottom?: boolean;
-    autoScrollToBottomThreshold?: number;
-    startAtBottom?: boolean;
+    maintainScrollAtEnd?: boolean;
+    maintainScrollAtEndThreshold?: number;
+    alignItemsAtEnd?: boolean;
     estimatedItemLength: (index: number) => number;
     onEndReached?: ((info: {
         distanceFromEnd: number;

package/index.d.ts

@@ -9,9 +9,9 @@ type LegendListProps<T> = Omit<ComponentProps<typeof ScrollView>, 'contentOffset
     initialContainers?: number;
     recycleItems?: boolean;
     onEndReachedThreshold?: number | null | undefined;
-    autoScrollToBottom?: boolean;
-    autoScrollToBottomThreshold?: number;
-    startAtBottom?: boolean;
+    maintainScrollAtEnd?: boolean;
+    maintainScrollAtEndThreshold?: number;
+    alignItemsAtEnd?: boolean;
     estimatedItemLength: (index: number) => number;
     onEndReached?: ((info: {
         distanceFromEnd: number;

package/index.js

@@ -86,9 +86,9 @@ var LegendList = React2.forwardRef(function LegendList2(props, forwardedRef) {
     drawDistance,
     recycleItems = true,
     onEndReachedThreshold,
-    autoScrollToBottom = false,
-    autoScrollToBottomThreshold = 0.1,
-    startAtBottom = false,
+    maintainScrollAtEnd = false,
+    maintainScrollAtEndThreshold = 0.1,
+    alignItemsAtEnd = false,
     keyExtractor,
     renderItem,
     estimatedItemLength,
@@ -144,7 +144,7 @@ var LegendList = React2.forwardRef(function LegendList2(props, forwardedRef) {
   const setTotalLength = (length) => {
     visibleRange$.totalLength.set(length);
     const screenLength = refPositions.current.scrollLength;
-    if (startAtBottom) {
+    if (alignItemsAtEnd) {
       const listPaddingTop = ((style == null ? void 0 : style.paddingTop) || 0) + ((contentContainerStyle == null ? void 0 : contentContainerStyle.paddingTop) || 0);
       paddingTop$.set(Math.max(0, screenLength - length - listPaddingTop));
     }
@@ -305,7 +305,7 @@ var LegendList = React2.forwardRef(function LegendList2(props, forwardedRef) {
     const newScroll = visibleRange$.scroll.peek();
     const distanceFromEnd = visibleRange$.totalLength.peek() - newScroll - scrollLength;
     if (refPositions.current) {
-      refPositions.current.isAtBottom = distanceFromEnd < scrollLength * autoScrollToBottomThreshold;
+      refPositions.current.isAtBottom = distanceFromEnd < scrollLength * maintainScrollAtEndThreshold;
     }
     if (onEndReached && !((_a = refPositions.current) == null ? void 0 : _a.isEndReached)) {
       if (distanceFromEnd < (onEndReachedThreshold || 0.5) * scrollLength) {
@@ -341,7 +341,7 @@ var LegendList = React2.forwardRef(function LegendList2(props, forwardedRef) {
       state.beginBatch();
       lengths.set(id, length);
       setTotalLength(visibleRange$.totalLength.peek() + (length - prevLength));
-      if (((_d = refPositions.current) == null ? void 0 : _d.isAtBottom) && autoScrollToBottom) {
+      if (((_d = refPositions.current) == null ? void 0 : _d.isAtBottom) && maintainScrollAtEnd) {
         requestAnimationFrame(() => {
           var _a2;
           (_a2 = refScroller.current) == null ? void 0 : _a2.scrollToEnd({
@@ -400,7 +400,7 @@ var LegendList = React2.forwardRef(function LegendList2(props, forwardedRef) {
       ...rest,
       ref: refScroller
     },
-    startAtBottom && /* @__PURE__ */ React2__namespace.createElement(react.Reactive.View, { $style: () => ({ height: paddingTop$.get() }) }),
+    alignItemsAtEnd && /* @__PURE__ */ React2__namespace.createElement(react.Reactive.View, { $style: () => ({ height: paddingTop$.get() }) }),
     ListHeaderComponent && /* @__PURE__ */ React2__namespace.createElement(react.Reactive.View, { $style: ListHeaderComponentStyle }, ListHeaderComponent),
     /* @__PURE__ */ React2__namespace.createElement(
       react.Reactive.View,

package/index.mjs

@@ -65,9 +65,9 @@ var LegendList = forwardRef(function LegendList2(props, forwardedRef) {
     drawDistance,
     recycleItems = true,
     onEndReachedThreshold,
-    autoScrollToBottom = false,
-    autoScrollToBottomThreshold = 0.1,
-    startAtBottom = false,
+    maintainScrollAtEnd = false,
+    maintainScrollAtEndThreshold = 0.1,
+    alignItemsAtEnd = false,
     keyExtractor,
     renderItem,
     estimatedItemLength,
@@ -123,7 +123,7 @@ var LegendList = forwardRef(function LegendList2(props, forwardedRef) {
   const setTotalLength = (length) => {
     visibleRange$.totalLength.set(length);
     const screenLength = refPositions.current.scrollLength;
-    if (startAtBottom) {
+    if (alignItemsAtEnd) {
       const listPaddingTop = ((style == null ? void 0 : style.paddingTop) || 0) + ((contentContainerStyle == null ? void 0 : contentContainerStyle.paddingTop) || 0);
       paddingTop$.set(Math.max(0, screenLength - length - listPaddingTop));
     }
@@ -284,7 +284,7 @@ var LegendList = forwardRef(function LegendList2(props, forwardedRef) {
     const newScroll = visibleRange$.scroll.peek();
     const distanceFromEnd = visibleRange$.totalLength.peek() - newScroll - scrollLength;
     if (refPositions.current) {
-      refPositions.current.isAtBottom = distanceFromEnd < scrollLength * autoScrollToBottomThreshold;
+      refPositions.current.isAtBottom = distanceFromEnd < scrollLength * maintainScrollAtEndThreshold;
     }
     if (onEndReached && !((_a = refPositions.current) == null ? void 0 : _a.isEndReached)) {
       if (distanceFromEnd < (onEndReachedThreshold || 0.5) * scrollLength) {
@@ -320,7 +320,7 @@ var LegendList = forwardRef(function LegendList2(props, forwardedRef) {
       beginBatch();
       lengths.set(id, length);
       setTotalLength(visibleRange$.totalLength.peek() + (length - prevLength));
-      if (((_d = refPositions.current) == null ? void 0 : _d.isAtBottom) && autoScrollToBottom) {
+      if (((_d = refPositions.current) == null ? void 0 : _d.isAtBottom) && maintainScrollAtEnd) {
         requestAnimationFrame(() => {
           var _a2;
           (_a2 = refScroller.current) == null ? void 0 : _a2.scrollToEnd({
@@ -379,7 +379,7 @@ var LegendList = forwardRef(function LegendList2(props, forwardedRef) {
       ...rest,
       ref: refScroller
     },
-    startAtBottom && /* @__PURE__ */ React2.createElement(Reactive.View, { $style: () => ({ height: paddingTop$.get() }) }),
+    alignItemsAtEnd && /* @__PURE__ */ React2.createElement(Reactive.View, { $style: () => ({ height: paddingTop$.get() }) }),
     ListHeaderComponent && /* @__PURE__ */ React2.createElement(Reactive.View, { $style: ListHeaderComponentStyle }, ListHeaderComponent),
     /* @__PURE__ */ React2.createElement(
       Reactive.View,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legendapp/list",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "legend-list",
   "sideEffects": false,
   "private": false,