-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from swup/next
Update for swup 4
- Loading branch information
Showing
16 changed files
with
5,715 additions
and
6,929 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Changelog | ||
|
||
<!-- ## [Unreleased] --> | ||
|
||
## [2.0.0] - 2023-07-26 | ||
|
||
- Switch to microbundle | ||
- Export native ESM module | ||
- Update for swup 4 compatibility | ||
|
||
## [1.1.0] - 2020-03-01 | ||
|
||
- Allow opting into reloading script | ||
|
||
## [1.0.0] - 2019-05-26 | ||
|
||
- Initial release | ||
|
||
[Unreleased]: https://github.com/swup/scripts-plugin/compare/2.0.0...HEAD | ||
|
||
[2.0.0]: https://github.com/swup/scripts-plugin/releases/tag/2.0.0 | ||
[1.1.0]: https://github.com/swup/scripts-plugin/releases/tag/1.1.0 | ||
[1.0.0]: https://github.com/swup/scripts-plugin/releases/tag/1.0.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Swup Scripts Plugin | ||
|
||
A [swup](https://swup.js.org) plugin for re-evaluating scripts. | ||
|
||
Re-run any `<script>` tags inside the `<head>` and/or `<body>` on every page view. This can be | ||
helpful if you don't have full control over the scripts included on your website. | ||
|
||
Ignores any script tags with the attribute `[data-swup-ignore-script]`. This attribute **must be** | ||
on the script tag that initializes swup itself to prevent creating multiple swup instances. | ||
|
||
**🚨 Warning:** Use this plugin as a last resort for projects with limited control over the included | ||
scripts. Running scripts without destroying previous ones can cause memory leaks and potentially | ||
break your page. | ||
|
||
## Installation | ||
|
||
Install the plugin from npm and import it into your bundle. | ||
|
||
```bash | ||
npm install @swup/scripts-plugin | ||
``` | ||
|
||
```javascript | ||
import SwupScriptsPlugin from '@swup/scripts-plugin'; | ||
``` | ||
|
||
Or include the minified production file from a CDN: | ||
|
||
```html | ||
<script src="https://unpkg.com/@swup/scripts-plugin@2"></script> | ||
``` | ||
|
||
## Usage | ||
|
||
To run this plugin, include an instance in the swup options. | ||
|
||
```javascript | ||
const swup = new Swup({ | ||
plugins: [new SwupScriptsPlugin()] | ||
}); | ||
``` | ||
|
||
## Options | ||
|
||
### head / body | ||
|
||
The plugin provides two boolean options — `head` and `body`. Both are set to `true` by default. | ||
Set these to `false` to disable re-evaluating scripts globally in the head or body of your website. | ||
|
||
```javascript | ||
new SwupScriptsPlugin({ | ||
head: true, | ||
body: true | ||
}); | ||
``` | ||
|
||
### optin | ||
|
||
Some third-party libraries like Google Tag Manager might not give you any control over how | ||
scripts are inserted into the page. In that case, enabling the `optin` option will only reload the | ||
scripts explicitly marked with a `[data-swup-reload-script]` attribute. | ||
|
||
```javascript | ||
new SwupScriptsPlugin({ | ||
optin: false | ||
}); | ||
``` |
Oops, something went wrong.