@effect-tui/react 0.5.0 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effect-tui/react",
-	"version": "0.5.0",
+	"version": "0.6.0",
 	"description": "React bindings for @effect-tui/core",
 	"type": "module",
 	"files": [
@@ -83,7 +83,7 @@
 		"prepublishOnly": "bun run typecheck && bun run build"
 	},
 	"dependencies": {
-		"@effect-tui/core": "^0.5.0",
+		"@effect-tui/core": "^0.6.0",
 		"@effect/platform": "^0.94.0",
 		"@effect/platform-bun": "^0.87.0",
 		"@effect/rpc": "^0.73.0",

package/src/components/ListView.tsx

@@ -0,0 +1,112 @@
+// ListView.tsx — Selection-aware scrolling list with scroll-into-view behavior
+import type { ReactNode } from "react"
+import { useEffect, useRef } from "react"
+import { useScroll } from "../hooks/use-scroll.js"
+
+export interface ListViewProps<T> {
+	/** Items to render */
+	items: readonly T[]
+	/** Currently selected index */
+	selectedIndex: number
+	/** Render function for each item */
+	renderItem: (item: T, index: number, isSelected: boolean) => ReactNode
+	/** Extract unique key for each item */
+	keyExtractor: (item: T, index: number) => string | number
+	/** Height of each item in rows (default: 1) */
+	itemHeight?: number
+	/** Padding rows to keep around selected item (default: 0) */
+	scrollPadding?: number
+	/** Show scrollbar (default: true) */
+	showScrollbar?: boolean
+	/** Empty state content when items is empty */
+	emptyContent?: ReactNode
+}
+
+/**
+ * A scrolling list view with selection and scroll-into-view behavior.
+ *
+ * Features:
+ * - Automatically scrolls to keep selected item visible when selection changes
+ * - Supports mouse wheel scrolling with macOS-style acceleration
+ * - Shows a scroll bar when content overflows
+ *
+ * Keyboard navigation should be handled by the parent component - update
+ * `selectedIndex` and ListView will scroll to keep it visible.
+ *
+ * @example
+ * ```tsx
+ * const [selectedIndex, setSelectedIndex] = useState(0)
+ *
+ * // Handle keyboard in parent
+ * useKeyboard((key) => {
+ *   if (key.name === "down" || key.text === "j") {
+ *     setSelectedIndex(i => Math.min(items.length - 1, i + 1))
+ *   }
+ *   if (key.name === "up" || key.text === "k") {
+ *     setSelectedIndex(i => Math.max(0, i - 1))
+ *   }
+ * })
+ *
+ * return (
+ *   <ListView
+ *     items={cards}
+ *     selectedIndex={selectedIndex}
+ *     renderItem={(card, i, isSelected) => (
+ *       <CardListItem card={card} isSelected={isSelected} />
+ *     )}
+ *     keyExtractor={(card) => card.id}
+ *   />
+ * )
+ * ```
+ */
+export function ListView<T>({
+	items,
+	selectedIndex,
+	renderItem,
+	keyExtractor,
+	itemHeight = 1,
+	scrollPadding = 0,
+	showScrollbar = true,
+	emptyContent,
+}: ListViewProps<T>) {
+	const { scrollProps, scrollToVisible } = useScroll({
+		enableKeyboard: false, // Parent handles keyboard for selection
+		enableMouseWheel: true, // Free scroll with wheel
+	})
+
+	// Track previous selection to detect changes
+	const prevSelectedRef = useRef(selectedIndex)
+
+	// Scroll to keep selection visible when it changes
+	useEffect(() => {
+		if (selectedIndex !== prevSelectedRef.current) {
+			prevSelectedRef.current = selectedIndex
+			scrollToVisible(selectedIndex, itemHeight, scrollPadding)
+		}
+	}, [selectedIndex, itemHeight, scrollPadding, scrollToVisible])
+
+	// Also scroll on initial render if selection is not 0
+	useEffect(() => {
+		if (selectedIndex > 0) {
+			scrollToVisible(selectedIndex, itemHeight, scrollPadding)
+		}
+		// Only run on mount
+		// eslint-disable-next-line react-hooks/exhaustive-deps
+	}, [])
+
+	if (items.length === 0 && emptyContent) {
+		return <>{emptyContent}</>
+	}
+
+	return (
+		<scroll {...scrollProps} showScrollbar={showScrollbar}>
+			<vstack>
+				{items.map((item, index) => (
+					<vstack key={keyExtractor(item, index)}>
+						{renderItem(item, index, index === selectedIndex)}
+					</vstack>
+				))}
+			</vstack>
+		</scroll>
+	)
+}

package/src/components/index.ts

@@ -1,4 +1,5 @@
 export { Divider, type DividerProps } from "./Divider.js"
+export { ListView, type ListViewProps } from "./ListView.js"
 export { Markdown, type MarkdownProps, type MarkdownTheme } from "./Markdown.js"
 export { MultilineTextInput, type MultilineTextInputProps } from "./MultilineTextInput.js"
 export { Overlay, type OverlayItemProps, type OverlayProps } from "./Overlay.js"

package/src/index.ts

@@ -6,6 +6,8 @@ export { CodeBlock } from "./codeblock.js"
 // Input components
 export {
 	type ColumnProps,
+	ListView,
+	type ListViewProps,
 	Markdown,
 	type MarkdownProps,
 	type MarkdownTheme,