パッケージの詳細

@swup/plugin

swup90.4kMIT4.0.0

Base class for creating swup plugins

Base class for creating swup plugins.

To create a new plugin, use the official swup plugin template. It comes with detailed instructions and the required tooling.

Import the base class and extend your plugin from it.

import Plugin from '@swup/plugin';

export default class PluginName extends Plugin {
  name = 'PluginName';
  mount() {}
  unmount() {}
}

The official swup command-line interface has commands to help with bundling and linting plugins.

npm install --save-dev @swup/cli

Bundle the plugin for production using microbundle, creating ESM and UMD builds.

# Bundle and transpile plugin code for distribution
swup package:bundle

# Bundle plugin code in watch mode
swup package:dev

Lint the plugin code using prettier and swup's recommended rules.

# Lint plugin code
swup package:lint

# Fix and format any lint errors
swup package:format

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 package:check