Pull to Refresh Web Component

A lightweight, customizable Web Component that adds pull-to-refresh functionality to your web applications. Perfect for mobile-first experiences and progressive web apps.

Demo

Live Demo (Source)

Additional Demos

• esm.sh CDN (Source) - Loading from esm.sh
• unpkg CDN (Source) - Loading from unpkg

Features

• Touch-optimized: Smooth pull gesture with momentum and feedback
• Customizable: Adjust threshold, text, and styling via attributes and CSS custom properties
• Event-driven: Rich event API for complete control over the refresh lifecycle
• Accessible: Semantic HTML and ARIA-friendly
• Framework-agnostic: Works with any framework or vanilla JavaScript
• Lightweight: No dependencies, just native Web Components
• Shadow DOM: Encapsulated styles that won't leak
• TypeScript-ready: Bundled definitions for editors and build tooling

TypeScript & Framework Support

• Bundled .d.ts files describe both PullToRefreshElement and definePullToRefresh, so modern editors provide autocomplete without extra config.
• Threshold/text/disabled props now reflect to attributes, keeping declarative templates in sync with imperative code.
• _upgradeProperty preserves pre-upgrade assignments—handy for SSR, hydration, and framework wrappers.
• Global HTMLElementTagNameMap augmentation lets TypeScript understand document.querySelector('pull-to-refresh') out of the box.

Quick Start

Installation

npm install @aarongustafson/pull-to-refresh

Usage

Option 1: Manual registration

import { PullToRefreshElement } from '@aarongustafson/pull-to-refresh';

customElements.define('pull-to-refresh', PullToRefreshElement);

Option 2: Auto-define (browser environments only)

import '@aarongustafson/pull-to-refresh/define.js';
// Registers <pull-to-refresh> when customElements is available

Prefer to control when registration happens? Call the helper directly:

import { definePullToRefresh } from '@aarongustafson/pull-to-refresh/define.js';

definePullToRefresh();

You can also include the guarded script from HTML:

<script src="./node_modules/@aarongustafson/pull-to-refresh/define.js" type="module"></script>

Basic Example

<pull-to-refresh>
  <div class="content">
    <h1>My Content</h1>
    <p>Pull down from the top to refresh!</p>
  </div>
</pull-to-refresh>

<script type="module">
  import '@aarongustafson/pull-to-refresh';

  const ptr = document.querySelector('pull-to-refresh');

  ptr.addEventListener('ptr:refresh', (e) => {
    // Perform your refresh logic (fetch data, etc.)
    fetch('/api/data')
      .then(response => response.json())
      .then(data => {
        // Update your content
        updateContent(data);
        // Signal completion
        e.detail.complete();
      });
  });
</script>

API

Attributes

Note: The text attributes use automatic localization based on the lang attribute or auto-detection. See Localization below.

Properties

All attributes are also available as properties:

const ptr = document.querySelector('pull-to-refresh');
ptr.threshold = 120;
ptr.indicatorText = 'Swipe down';
ptr.disabled = true;

Events

Important: Call event.detail.complete() in your ptr:refresh handler to signal completion:

ptr.addEventListener('ptr:refresh', (e) => {
  doAsyncWork().then(() => {
    e.detail.complete(); // Call this when done
  });
});

If you don't call complete(), the component will auto-complete after 2 seconds.

Slots

CSS Custom Properties

Methods

Examples

Custom Threshold

<pull-to-refresh threshold="120">
  <div>Content here</div>
</pull-to-refresh>

Localization

The component automatically detects the language and displays localized text:

<!-- Spanish -->
<pull-to-refresh lang="es">
  <div>Contenido aquí</div>
</pull-to-refresh>

<!-- French -->
<pull-to-refresh lang="fr">
  <div>Contenu ici</div>
</pull-to-refresh>

<!-- Japanese -->
<pull-to-refresh lang="ja">
  <div>ここにコンテンツ</div>
</pull-to-refresh>

The component supports 16 languages with automatic fallback to English. Language is detected from:

1. The element's lang attribute
2. The nearest ancestor's lang attribute
3. The document's lang attribute
4. Default: English

You can also register custom translations:

import { PullToRefreshElement } from '@aarongustafson/pull-to-refresh';

PullToRefreshElement.registerTranslations({
  'pt-BR': {
    indicator: '↓ Puxe para atualizar',
    release: '↻ Solte para atualizar',
    refreshing: '⏳ Atualizando...'
  }
});

Custom Styling

<style>
  pull-to-refresh {
    --ptr-indicator-bg: #f0f0f0;
    --ptr-indicator-color: #1976d2;
    --ptr-indicator-font-size: 1rem;
    --ptr-indicator-height: 3.75rem;
  }
</style>

<pull-to-refresh>
  <div>Content here</div>
</pull-to-refresh>

Custom Messages

<pull-to-refresh
  indicator-text="⬇ Swipe down"
  release-text="🔄 Let go!"
  refreshing-text="⏳ Loading...">
  <div>Content here</div>
</pull-to-refresh>

With Fetch API

ptr.addEventListener('ptr:refresh', async (e) => {
  try {
    const response = await fetch('/api/latest');
    const data = await response.json();
    renderData(data);
  } catch (error) {
    console.error('Refresh failed:', error);
  } finally {
    e.detail.complete();
  }
});

Disabled State

<!-- Disable pull-to-refresh when needed -->
<pull-to-refresh disabled>
  <div>No refresh available</div>
</pull-to-refresh>

<script>
  // Or toggle programmatically
  ptr.disabled = true;
</script>

Tracking Pull Distance

ptr.addEventListener('ptr:pull-move', (e) => {
  console.log('Pull distance:', e.detail.distance);
  // Use this for custom animations, etc.
});

Localization (i18n)

The component includes built-in translations for 16 languages:

Language Detection

The component uses a cascading fallback approach:

1. Element's lang attribute: <pull-to-refresh lang="es">
2. Nearest ancestor with lang: <div lang="fr"><pull-to-refresh>
3. Document language: <html lang="de">
4. Default: English (en)

Regional variants (e.g., en-US, es-MX, fr-CA) automatically fall back to their base language.

Custom Translations

Register custom translations or override existing ones:

import { PullToRefreshElement } from '@aarongustafson/pull-to-refresh';

// Add a new language
PullToRefreshElement.registerTranslations({
  'nl': {
    indicator: '↓ Trek om te vernieuwen',
    release: '↻ Loslaten om te vernieuwen',
    refreshing: '⏳ Vernieuwen...'
  }
});

// Override existing translations
PullToRefreshElement.registerTranslations({
  'en': {
    indicator: '⬇ Pull down',
    release: '🔄 Let go',
    refreshing: '⏳ Loading...'
  }
});

Per-Instance Overrides

You can always override translations for individual instances:

<pull-to-refresh
  lang="es"
  indicator-text="Custom Spanish text"
  release-text="Custom release text">
  <!-- Content -->
</pull-to-refresh>

Testing

npm test               # Run tests in watch mode
npm run test:run       # Run tests once
npm run test:ui        # Open Vitest UI
npm run test:coverage  # Generate coverage report

Development

npm install            # Install dependencies
npm run setup          # Run setup wizard (first time)
npm run lint           # Lint code
npm run format         # Format code

Browser Support

Works in all modern browsers supporting:

• Custom Elements v1
• Shadow DOM v1
• ES Modules
• Pointer Events

For legacy browsers, use appropriate polyfills.

Package Exports

// Auto-define
import '@aarongustafson/pull-to-refresh';

// Class only
import { PullToRefreshElement } from '@aarongustafson/pull-to-refresh/pull-to-refresh.js';

// Both
import { PullToRefreshElement } from '@aarongustafson/pull-to-refresh';

// Manual define script
import '@aarongustafson/pull-to-refresh/define.js';

Contributing

Contributions welcome! See CONTRIBUTING.md for guidelines.

License

MIT - See LICENSE

Credits

Created by Aaron Gustafson

Try it out! Check out the live demo 🚀