swup-morph-plugin

KO | EN

gitlite — search

#python #hacktoberfest #react #android #linux #docker #java #awesome #cli #vue #pytorch #mcp #openai #open-source

swup-morph-plugin

(★ 23)

A swup plugin for morphing DOM nodes in place

swup-morph-plugin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Swup Morph Plugin

A [swup](https://swup.js.org) plugin for morphing dom nodes into the new page.

Allows morphing containers into the new page without replacing or animating them. The prime use
cases are headers and menus on multi-language sites: you might not want to swap these elements out
with a transition on each page visit, however you'd still want to update any URLs, labels or
classnames when the user switches between languages.

Behind the scenes, it uses
[Morphlex](https://github.com/yippee-fun/morphlex) to update the
existing DOM nodes to match the same DOM nodes on the new page being loaded.
This will leave any event handlers in place, as opposed to setting `innerHTML`
on the target.

## Installation

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

```bash
npm install swup-morph-plugin
```

```js
import SwupMorphPlugin from 'swup-morph-plugin';
```

Or include the minified production file from a CDN:

```html
<script src="https://unpkg.com/swup-morph-plugin@1"></script>
```

## Usage

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

```javascript
const swup = new Swup({
  plugins: [new SwupMorphPlugin()]
});
```

## Morphed containers

The plugin provides two ways of choosing the containers to be morphed:

### Container option

Pass in a list of selectors into the plugin options to let it know about morphable containers. Use
this method if you have a limited and predictable number of containers to morph.

```javascript
new SwupMorphPlugin({
  containers: ['#nav']
})
```

```html
<nav id="nav">
  
</nav>
<main id="swup">
  
</main>
```

### Data attribute

Add a `data-swup-morph` attribute with a **unique** identifier on containers to be morphed. The
plugin will find all containers with this attribute and match the outgoing and incoming versions
of each container by the value of the attribute. Use this method if you have lots of dynamically
created morphable containers.

```html
<nav data-swup-morph="nav">
  
</nav>
<main id="swup">
  
</main>
```

## Options

### containers

Array of specific DOM selectors that will be morphed into the new page.

```javascript
{
  containers: ['#nav']
}
```

### updateCallbacks

Callbacks to run before elements are updated. This can be used to persist or
discard certain attributes. If the callback returns `false`, the element will
not be updated. See the [Morphlex docs](https://github.com/yippee-fun/morphlex)
on the `beforeNodeVisited` option for details.

```javascript
{
  containers: ['#widget'],
  updateCallbacks: [
    (fromEl, toEl) => {
      // Persist ARIA attributes on buttons and inputs
      if (fromEl.hasAttribute('aria-pressed')) {
        toEl.setAttribute('aria-pressed', fromEl.getAttribute('aria-pressed'))
      }
    }
  ]
}
```

### morphlexOptions

Options to pass to Morphlex when morphing. See the [Morphlex docs](https://github.com/yippee-fun/morphlex#options)
for available options.

```javascript
{
  containers: ['#widget'],
  morphlexOptions: {
    // Overwrite form input values with the server value
    preserveChanges: false
  }
}

swup-morph-plugin

swup-morph-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

swup-morph-plugin

swup-morph-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README