Skip to content

Latest commit

Β 

History

History
133 lines (99 loc) Β· 4.26 KB

File metadata and controls

133 lines (99 loc) Β· 4.26 KB
layout default
title Getting Started
eleventyNavigation
key order
Getting Started
0
permalink /getting-started/

Getting Started

What is swup?

Swup is a versatile and extensible page transition library for server-rendered websites. It manages the complete page load lifecycle and smoothly animates between the current and next page. In addition, it offers many other quality-of-life improvements like caching, smart preloading, native browser history and enhanced accessibility.

Make your site feel like a snappy single-page app β€” without any of the complexity.

/assets/images/swup-demos.mp4

Features

  • ✏️ Works out of the box with minimal markup
  • ✨ Auto-detects animations for perfect timing
  • πŸ”— Updates URLs and preserves native browser history
  • πŸ“ Manages scroll position between pages and anchor links
  • πŸš€ Uses a cache to speed up subsequent page loads
  • πŸ“‘ Offers hooks to customize and extend the page load lifecycle
  • πŸ”Œ Has a powerful plugin system and many official and third-party plugins
  • 🎨 Provides ready-to-go themes to get started quickly

See How it works for an overview of the key concepts.

Try it out

Explore our interactive demos to see swup in action.

Plugins

Swup is small by design. Extended features can be added via plugins:

Check out the list of official plugins and third-party plugins.

Themes

Get started quickly with one of three official themes: fade, slide, and overlay.

Having trouble?

If you're having trouble implementing swup, check out Common Issues, look at closed issues, or create a new discussion.

Want to contribute?

Become a sponsor on Open Collective or support development through GitHub sponsors.

License

Swup is released under the MIT license.