/overlay-theme

🎨 Simple, yet powerful, customisable swup theme with sliding overlay.

Primary LanguageJavaScriptMIT LicenseMIT

Swup Overlay Theme

Theme for slide in/out animation of overlay.

Instalation

This theme can be installed with npm

npm install @swup/overlay-theme

and included with import

import SwupOverlayTheme from '@swup/overlay-theme';

or included from the dist folder

<script src="./dist/SwupOverlayTheme.js"></script>

Usage

To run this theme, include an instance in the swup options.

const swup = new Swup({
  theme: [new SwupOverlayTheme()]
});

Options

color

Changes color of the overlay element.
Defaults to #2D2E82.