Reference version

This documentation is available as Markdown for AI agents and LLMs. See the full Markdown index or append .md to any documentation URL.

LazyHStack

A SwiftUI LazyHStack component for lazy horizontal layouts.

iOS
tvOS
Included in Expo Go
Recommended version:
~58.0.10

Expo UI LazyHStack matches the official SwiftUI LazyHStack API and arranges its children horizontally.

Installation

Terminal
- npx expo install @expo/ui
- yarn expo install @expo/ui
- pnpm expo install @expo/ui
- bun expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Basic lazy horizontal stack

Put LazyHStack inside a ScrollView with axes="horizontal". Each child of LazyHStack is one item. Use the spacing and alignment props to space and align the items.

BasicLazyHStackExample.tsx
import { Host, ScrollView, LazyHStack, Text, } from '@expo/ui/swift-ui'; export default function BasicLazyHStackExample() { return ( <Host style={{ flex: 1 }}> <ScrollView axes="horizontal"> <LazyHStack spacing={12}> <Text>Photos</Text> <Text>Music</Text> <Text>Videos</Text> </LazyHStack> </ScrollView> </Host> ); }

Large lists

Use LazyHStack.ForEach to render items from an array. Pass the items as data, a unique key for each item with keyExtractor, and a children function that returns the view for an item. LazyHStack.ForEach renders only the items near the visible area and reuses them while you scroll.

LargeLazyHStackExample.tsx
import { Host, ScrollView, LazyHStack, Text, } from '@expo/ui/swift-ui'; const items = Array.from( { length: 10000 }, (_, i) => `Item ${i + 1}` ); function renderItem({ item }: { item: string }) { return <Text>{item}</Text>; } export default function LargeLazyHStackExample() { return ( <Host style={{ flex: 1 }}> <ScrollView axes="horizontal"> <LazyHStack spacing={12}> <LazyHStack.ForEach data={items} keyExtractor={item => item} estimatedItemSize={80}> {renderItem} </LazyHStack.ForEach> </LazyHStack> </ScrollView> </Host> ); }

Follow these rules when you render items:

  • Define the children function outside the component, or wrap it in useCallback. Otherwise, the items near the visible area render again each time the component renders.
  • A reused view keeps the local state (useState) of the item it showed before. Reset the state when the item changes, or keep the state outside the view.
  • An item that is not ready yet shows an empty placeholder. Set estimatedItemSize close to the width of your items, in points.
  • Use overscanCount to prepare more items before and after the visible items.
  • To update the items, pass a new data array. Do not change the array in place.
  • Set recycling={false} to render every item up front.

API

import { LazyHStack } from '@expo/ui/swift-ui';

Components

LazyHStackForEach

iOS
tvOS

Type: React.Element<LazyHStackForEachProps<T>>

A block of recycled items inside LazyHStack. Only a small pool of items around the visible range is mounted. Items that are not ready yet show a placeholder of estimatedItemSize, or of the size last measured for that item.

Mount it as a direct child of LazyHStack.

LazyHStackForEachProps

children

iOS
tvOS
Type: (info: { index: number, item: T }) => ReactElement

Renders an item. Wrap it in useCallback, or every item re-renders on each parent render. Recycled views are reused for other items, so their local state (useState) carries over. Reset it when the item changes, or keep the state outside the view.

data

iOS
tvOS
Type: readonly T[]

Items to display. Replace the array when updating data.

estimatedItemSize

iOS
tvOS
Optional • Type: number • Default: 64

Placeholder size in points along the stack axis, until an item is measured. Must be positive. Ignored when recycling is false.

keyExtractor

iOS
tvOS
Type: (item: T, index: number) => string

Returns a stable, unique string key for each item.

overscanCount

iOS
tvOS
Optional • Type: number • Default: 10

Extra items to prepare on each side of the visible items. Must be a non-negative integer. Ignored when recycling is false.

recycling

iOS
tvOS
Optional • Type: boolean • Default: true

Renders only the items near the visible range and reuses them while scrolling. Set to false to render every item at once. Set it once; changing it remounts the items.

LazyHStack

iOS
tvOS

Type: React.Element<LazyHStackProps>

LazyHStackProps

alignment

iOS
tvOS
Optional • Literal type: string

The vertical alignment of children within the stack.

Acceptable values are: 'center' | 'top' | 'bottom' | 'firstTextBaseline' | 'lastTextBaseline'

children

iOS
tvOS
Type: ReactNode

spacing

iOS
tvOS
Optional • Type: number

The spacing between children.