Merge pull request #1 from swup/next

Update for swup 4

.github/workflows/npm-publish.yml

@@ -10,11 +10,11 @@ jobs:
  publish-npm:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v1
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v3
  with:
- node-version: 12
- registry-url: https://registry.npmjs.org/
+ node-version: 16
+ registry-url: https://registry.npmjs.org
  - run: npm ci
  - run: npm publish --access public
  env:

.github/workflows/version-update.yml

@@ -0,0 +1,35 @@
+# This workflow bumps the package.json version and creates a PR
+
+name: Update package version
+
+on:
+ workflow_dispatch:
+ inputs:
+ segment:
+ description: 'Semver segment to update'
+ required: true
+ default: 'patch'
+ type: choice
+ options:
+ - minor
+ - patch
+
+jobs:
+ update-version:
+ name: Update package version
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-node@v2
+ with:
+ node-version: 16
+ - run: echo "Updating ${{ inputs.segment }} version"
+ - name: Update version
+ run: npm --no-git-tag-version version ${{ inputs.segment }}
+ - uses: peter-evans/create-pull-request@v4
+ with:
+ base: 'master'
+ branch: 'version/automated'
+ title: 'Update package version (automated)'
+ commit-message: 'Update package version'
+ body: 'Automated update to ${{ inputs.segment }} version'

.gitignore

@@ -13,8 +13,7 @@ wiki-wishlist
 *.sublime-workspace
 .editorconfig
 .idea
-lib
-/plugins
+/dist
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+<!-- ## [Unreleased] -->
+
+## [2.0.0] - 2023-07-26
+
+- Switch to microbundle
+- Export native ESM module
+- Update for swup 4 compatibility
+- Include query params in location key
+
+## [1.0.0] - 2021-06-07
+
+- Initial release
+
+[Unreleased]: https://github.com/swup/livewire-plugin/compare/2.0.0...HEAD
+
+[2.0.0]: https://github.com/swup/livewire-plugin/releases/tag/2.0.0
+[1.0.0]: https://github.com/swup/livewire-plugin/releases/tag/1.0.0

README.md

@@ -0,0 +1,33 @@
+# Swup Livewire Plugin
+
+A [swup](https://swup.js.org) plugin for integrating [Laravel Livewire](https://laravel-livewire.com/).
+
+Re-initialize Livewire components after each page change.
+
+## Installation
+
+Install the plugin from npm and import it into your bundle.
+
+```bash
+npm install @swup/livewire-plugin
+```
+
+```js
+import SwupLivewirePlugin from '@swup/livewire-plugin';
+```
+
+Or include the minified production file from a CDN:
+
+```html
+<script src="https://unpkg.com/@swup/livewire-plugin@2"></script>
+```
+
+## Usage
+
+To run this plugin, include an instance in the swup options.
+
+```javascript
+const swup = new Swup({
+ plugins: [new SwupLivewirePlugin()]
+});
+```