@swup/body-class-plugin
TypeScript icon, indicating that this package has built-in type declarations

3.2.0 • Public • Published

Swup Body Class Plugin

A swup plugin for updating the body classname after each page load.

Installation

Install the plugin from npm and import it into your bundle.

npm install @swup/body-class-plugin
import SwupBodyClassPlugin from '@swup/body-class-plugin';

Or include the minified production file from a CDN:

<script src="https://unpkg.com/@swup/body-class-plugin@3"></script>

Usage

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

const swup = new Swup({
  plugins: [new SwupBodyClassPlugin()]
});

Options

prefix

By default, all classes are updated. If your site uses classes on the body element for functionality like opening menus, you can tell the plugin to only update classnames starting with a prefix, e.g. page-. It will then only update those classes and leave all other classes untouched.

{
  prefix: 'page-'
}

Readme

Keywords

none

Package Sidebar

Install

npm i @swup/body-class-plugin

Weekly Downloads

2,574

Version

3.2.0

License

MIT

Unpacked Size

20.3 kB

Total Files

12

Last publish

Collaborators

  • hirasso
  • daun
  • gmrchk