Skip to content

PullToRefresh

A scrolling list you pull down from the top to reload: the content follows your finger with a rubber band, a molded key turns as you pull and clicks at the detent, and the list holds there with the Loader's lights until onRefresh settles. A real Refresh button and one status make it work without the gesture.

Feel The top of the list is on a spring: pull it and it stretches, a key rises in the gap and clicks when you've pulled far enough, and it holds there, lit, until the new rows land.

Preview

  • Review onboarding copyToday
  • Reply to the Figma threadToday
  • Book the planning roomToday
  • Check the billing exportToday
  • Draft the release notesToday
  • Send the Q4 surveyToday

Or let the agent fetch it: get_component("pull-to-refresh") on the Echo MCP server.

Installation

npx echo-ui-cli add pull-to-refresh

First time? Run npx echo-ui-cli init once — it sets the project up, and add refuses to run before it.

At a glance

Version
0.3.0
Weight
1.7 KB · 29.3 KB with what it imports · 1.2 KB of CSS (minified and gzipped; React not counted)
Needs
loader (Echo, brought with it)
Keyboard
The pull is a gesture, so it is never the only way: the region's first tab stop is a real "Refresh {label}" button, visually hidden until it has keyboard focus.
Reduced motion
The content still follows the finger (that is the gesture), but it jumps home and to the detent instead of springing.
Sound
select as the pull passes the detent, notify when the refresh finishes, inside a SoundProvider.

Usage

tsx
import { PullToRefresh } from "@/echo/pull-to-refresh";

<PullToRefresh label="tasks" onRefresh={refetch}>{list}</PullToRefresh>

Composition

PullToRefresh (the scroll region)
  Refresh button (shown on focus)
  status
  indicator key → Loader while refreshing
  your content

Examples

A list that reloads

Give it the height to scroll in; it holds at the detent until your promise settles.

tsx
<div style={{ height: 480 }}>
  <PullToRefresh label="tasks" onRefresh={() => refetch()}>
    <Stack as="ul" gap={0}>{items}</Stack>
  </PullToRefresh>
</div>

Accessibility

  • The pull is a gesture, so it is never the only way: the region's first tab stop is a real "Refresh {label}" button, visually hidden until it has keyboard focus.
  • One status, on the page from the start, says "Refreshing tasks…" and then "Tasks up to date"; the indicator itself is decoration.
  • Only a downward pull from the very top counts; a sideways drag (a row's swipe actions) or an upward one (a scroll) is left alone.
  • A pull that ends over a row doesn't click the row.

Tested against WCAG 2.2 AA on every release:

  • axe — No axe violations, in the component's own gallery and on its page.
  • keyboard — Every action is reachable and operable from the keyboard alone.
  • focus-visible — Focus is visible on every focusable part, in normal and forced-colors mode.
  • forced-colors — State stays visible when the look's colours are replaced by the system's.
  • target-size — Every target's real hit area is at least 24×24px, at every density.
  • reflow — Content reflows into 320px and survives a doubled text size.

Not covered: screen-reader: not yet verified by a person. Everything above is a machine check; a person has not yet driven this component with a screen reader.

Motion & sound

Reduced motion
The content still follows the finger (that is the gesture), but it jumps home and to the detent instead of springing.
Sound
select as the pull passes the detent, notify when the refresh finishes, inside a SoundProvider.

Props

PullToRefresh props
PropTypeDefault
onRefresh requiredReload. The list holds at the detent, with the Loader's lights, until the promise settles.function
children requiredThe scrolling content: usually a list of Items.unknown
labelWhat is refreshed, for the button and the status: "tasks" gives "Refresh tasks" and "Tasks up to date".string"list"
thresholdHow far to pull, in px, before letting go refreshes.number64
disabledTurn the gesture off. The Refresh button still works.booleanfalse
classNameA class on the scroller.string

Anti-patterns

  • Do not make pull-to-refresh the only way to reload. The component has the button; don't hide it with CSS.
  • Do not put it around a page that already scrolls: it is the scroller, so give it a height (a flex child, a fixed-height app body).
  • Do not refresh on a timer and also ask people to pull. Pick one: a pull that does nothing new teaches people it is broken.

Changelog

  • v0.3.0 · 2026-10-12 · ChangedEvery item needs echo-ui-core 0.3.0 (all components). The drawn device, readability past AA and the design tests live in core, and the components that use them are built against it, so each item now declares echo-ui-core >=0.3.0 <0.4.0. Update core with the items: npm install echo-ui-core@^0.3.0 (or your package manager's), then npx echo-ui-cli update. An item whose files didn't change is the same code under a new version; the 0.2.0 files stay published.
  • v0.2.0 · 2026-10-04 · AddedThe light device (echo-ui-core, echo-ui-cli). Echo can be light: a pale chassis makes a device molded in light plastic, like a white calculator or a cream radio, and a dark one makes the device Echo has always been. There's no setting and no mode to switch; the chassis decides (devicePolarity, and values.polarity on the theme). On a light device the page is light: its ground, the well, is the body barely set in. Caps get their own ladder, a step lighter than the body with a lit rim that stops short of white, so they keep their bevel; undersides and seams are shaded darker; dim text moves toward the ground by the same step as on a dark device, and reads about 6:1 on it. Screens are paper glass printed in ink, because a glow on a pale body is a smudge. What's lit (an LED, the current rail) is still the accent, held to 3:1 on every ground, so on is brighter than off; the text it prints (a readout, a count, a current tab) and the focus ring are the accent's ink, a step deeper and held to AA, in the new accent-ink role. The primary cap is the same cap as a dark device's, the accent with a light label: its label is the new primary-cap-ink role, and progress cells, loader dots and a meter's fill, the same plastic, read 3:1 on the page. A neutral cap or a slider that fills with it under its own dark label fills with the new pour-* roles, the accent's pale stops. Shadows are drawn at half their weight, in a deep colour of the body's own hue (--echo-cast-ink) instead of black. Every guarantee holds as it does on a dark device, and the contrast sweep now runs on light bodies too. A dark seed makes exactly the theme it did before, and the new roles equal the ones they stand for there. The components that mixed a recess toward black, painted paper in the text colour or lit a pillow of light with it read the theme's new --echo-shade-ink, --echo-paper-stock and --echo-paper-ink instead, with the old value as the fallback, and a reflective screen reads --echo-screen-*; the components that print a lit label read --echo-primary-cap-ink and --echo-accent-ink the same way; every rail is drawn in the glow, and every focus ring, the ring recipes included, in the ink. style use wears a light style now, and style check says which device a style makes. A dark screen tint on a light body is still refused: one text colour can't serve both, and the theme says so.
  • v0.2.0 · 2026-10-04 · AddedPullToRefresh: a list you pull down from the top to reload. The content follows your finger on the library's rubber band, a molded key turns as you pull and clicks at the detent, and the list holds there with the Loader's lights until onRefresh settles. The gesture is never the only way: the region's first tab stop is a real Refresh button, and one status says what happened.
  • v0.2.0 · 2026-10-04 · ChangedComments only, no behaviour change. Comments in the component source used to cite documents, milestones and ticket numbers from Echo's own planning, none of which exist in your project. The citations are gone and the sentences around them stay. Where a comment was only a citation, it now says what it meant. Three development warnings (HardwareButton's engraved/caption checks and StatusDot's missing-label check) also dropped the ticket code at the end of the message. echo-ui diff will show changes in most items; none of them are to code.
  • v0.2.0 · 2026-10-04 · ChangedAn item's version is now a function of declared data, not of how the changelog is formatted. The version an item ships under is published once and never rewritten, and it used to be inferred from prose: a regex for a bolded "Breaking" run across the whole unreleased section, and attribution by "does a bullet mention this name in backticks". One breaking entry therefore moved every item that changed that cycle, and an entry explaining that "Menu and Sheet are unchanged here" filed itself as a change to Menu and Sheet — which it really had.
  • v0.2.0 · 2026-10-04 · ChangedThe agent brief says Echo has not shipped. llms.txt and the MCP server's instructions led with npx echo-ui-cli init, and that name on npm is a reserved stub with no executable — so a model following the brief wrote an install step that fails with npx's own error. The brief now opens with the caveat, and the docs carry it on every surface that shows a command. One switch (CLI_RELEASED) silences all of them at launch, and a test refuses to let one move without the others. Affects all components only in what the brief says about installing them; no item's props, CSS or rendered semantics change.
  • v0.2.0 · 2026-10-04 · ChangedEcho's home is echo-ui.com. The registry, the docs and the packages all move to it from echo.nawwara.studio. Nothing was published under the old host, so no echo.json anywhere points at it and there is nothing to migrate — this is the last release where that is true.
  • v0.2.0 · 2026-10-04 · ChangedWeights, line heights, letter-spacing, z-index, border widths and icon sizes come from the theme scales in all components, with the old value as a fallback, so components keep working with echo-ui-core@0.0.1. Strays moved to the nearest step: most by under a pixel; HardwareButton icons are 14/16/20px (were 15/17/19).
  • v0.2.0 · 2026-10-04 · FixedA light device's recesses keep the body's hue in Chromium (echo-ui-core, BUG-166). Chromium drops the hue of a colour under 0.02 chroma when it mixes in oklch, and draws the mix at hue 0, a rose. A light device's plastic is that grey, so on a lilac body every field, track and rail was pink. A mix made only of greys is made in oklab now, which has no hue to lose; a mix with an accent in it stays in oklch. On a dark device nothing you can see changes.
  • v0.2.0 · 2026-10-04 · FixedContent now reflows into a 320px screen (400% zoom) and survives a doubled browser text size (WCAG 1.4.10, 1.4.4), across all components. Select's 180px floor, NumberField's readout, Segmented and Steps as flex items, EmptyState's grid columns, and Avatar's fixed-pixel disc all gave way; Panel counts its padding inside a width you set (box-sizing: border-box), so a <Panel style={{ width: 220 }}> is now 220px wide overall rather than 260px.