Skip to main content
161

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
React Native docs
FeedbackReact Native

Refresh control

Apply Lumen semantic colors to React Native pull-to-refresh behavior.

Public APILumenRefreshControlReact Native

Native example

Use Refresh control

Attach to a React Native ScrollView or compatible list. Keep refresh state and completion in application code.

View verified React Native runtime capture
Refresh control rendered in the Expo web renderer Lumen playground
Verified runtime captureExpo web renderer
tsx
<ScrollView
  refreshControl={(
    <LumenRefreshControl
      accessibilityLabel="Refresh projects"
      refreshing={refreshing}
      onRefresh={refreshProjects}
    />
  )}
>
  {content}
</ScrollView>

Reference

Public API

The primary shared and platform-specific options exposed by LumenRefreshControl.

APIValues or typeDefaultDescription
refreshingbooleanRequiredReports whether the native indicator is active.
onRefresh() => voidRequiredStarts the application refresh operation.
indicatorTonebrand · accent · neutralbrandSelects the semantic native indicator color.
accessibilityLabelstringApplication-providedNames the content refreshed by the gesture.

Native behavior

Design and accessibility

When to use it

Attach to a React Native ScrollView or compatible list. Keep refresh state and completion in application code.

Accessibility

The native refresh gesture remains owned by the scroll container. Supply an accessibility label that describes the refreshed content.

React Native docsNative primitives