2.0.0-rc.2 • Published 1 year ago
@daun/swup-plugin v2.0.0-rc.2
Swup Base Plugin
Base class for creating swup plugins.
Creating a Plugin
To create a new plugin, use the official swup plugin template. It comes with detailed instructions and the required tooling.
Usage
import Plugin from '@swup/plugin';
export default class PluginName extends Plugin {
name = 'PluginName';
mount() {}
unmount() {}
}
Commands
The base plugin provides a few simple command line tools to help with bundling and linting.
Bundling
Bundle the plugin for production using microbundle, creating ESM and UMD builds.
# Bundle and transpile plugin code
swup-plugin bundle
# Bundle plugin code in watch mode
swup-plugin dev
Linting & formatting
Lint the plugin code using prettier and swup's recommended rules.
# Lint plugin code
swup-plugin lint
# Fix and format any lint errors
swup-plugin format
Package info
Check that the plugin's package.json file contains the required information for microbundle: input, output, export map, amd name, etc.
# Check plugin package info
swup-plugin check
2.0.0-rc.2
1 year ago
2.0.0-rc.1
1 year ago
2.0.3
1 year ago
2.0.2
1 year ago
2.0.1
1 year ago
2.0.0
1 year ago