swup 4.0.0-rc.14 → 4.0.0-rc.21

package/dist/types/modules/destroy.d.ts

@@ -1,2 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const destroy: (this: InternalSwup) => void;

package/dist/types/modules/enable.d.ts

@@ -1,2 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const enable: (this: InternalSwup) => void;

package/dist/types/modules/events.d.ts

@@ -1,33 +0,0 @@
-import Swup from '../Swup';
-import delegate from 'delegate-it';
-type HandlersEventMap = {
-    animationInDone: undefined;
-    animationInStart: undefined;
-    animationOutDone: undefined;
-    animationOutStart: undefined;
-    animationSkipped: undefined;
-    clickLink: delegate.Event<MouseEvent>;
-    contentReplaced: PopStateEvent | undefined;
-    disabled: undefined;
-    enabled: undefined;
-    openPageInNewTab: delegate.Event<MouseEvent>;
-    pageLoaded: undefined;
-    pageRetrievedFromCache: undefined;
-    pageView: PopStateEvent | undefined;
-    popState: PopStateEvent;
-    samePage: delegate.Event<MouseEvent>;
-    samePageWithHash: delegate.Event<MouseEvent>;
-    serverError: undefined;
-    transitionStart: PopStateEvent | undefined;
-    transitionEnd: PopStateEvent | undefined;
-    willReplaceContent: PopStateEvent | undefined;
-};
-type AvailableEventNames = keyof HandlersEventMap;
-export type Handler<T extends keyof HandlersEventMap> = (event: HandlersEventMap[T]) => void;
-export type Handlers = {
-    [Key in keyof HandlersEventMap]: Handler<Key>[];
-};
-export declare function on<TEventType extends AvailableEventNames>(this: Swup, event: TEventType, handler: Handler<TEventType>): void;
-export declare function off<TEventType extends AvailableEventNames>(this: Swup, event?: TEventType, handler?: Handler<TEventType>): void;
-export declare function triggerEvent<TEventType extends AvailableEventNames>(this: Swup, eventName: TEventType, originalEvent?: HandlersEventMap[TEventType]): void;
-export {};

package/dist/types/modules/getAnimationPromises.d.ts

@@ -1,7 +0,0 @@
-import Swup from '../Swup';
-export declare function getAnimationPromises(this: Swup, animationType: 'in' | 'out'): Promise<void>[];
-export declare function getTransitionInfo(element: Element, expectedType?: 'animation' | 'transition' | null): {
-    type: string | null;
-    timeout: number;
-    propCount: number;
-};

package/dist/types/modules/getPageData.d.ts

@@ -1,6 +0,0 @@
-import Swup from '../Swup';
-import { PageHtmlData } from '../helpers/getDataFromHtml';
-export type PageData = PageHtmlData & {
-    responseURL: string;
-};
-export declare const getPageData: (this: Swup, request: XMLHttpRequest) => PageData | null;

package/dist/types/modules/handleLinkToSamePage.d.ts

@@ -1,2 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const handleLinkToSamePage: (this: InternalSwup, url: string, hash: string, event: MouseEvent) => void;

package/dist/types/modules/isSameResolvedUrl.d.ts

@@ -1,8 +0,0 @@
-import { InternalSwup } from '../Swup';
-/**
- * Compares the resolved version of two paths and returns true if they are the same
- * @param {string} url1
- * @param {string} url2
- * @returns {boolean}
- */
-export declare const isSameResolvedUrl: (this: InternalSwup, url1: string, url2: string) => boolean;

package/dist/types/modules/linkClickHandler.d.ts

@@ -1,3 +0,0 @@
-import { InternalSwup } from '../Swup';
-import delegate from 'delegate-it';
-export declare const linkClickHandler: (this: InternalSwup, event: delegate.Event<MouseEvent>) => void;

package/dist/types/modules/loadPage.d.ts

@@ -1,12 +0,0 @@
-import Swup from '../Swup';
-export type TransitionOptions = {
-    url: string;
-    customTransition?: string;
-};
-export type PageLoadOptions = {
-    url: string;
-    event?: PopStateEvent;
-    customTransition?: string;
-};
-export declare function loadPage(this: Swup, data: TransitionOptions): void;
-export declare function performPageLoad(this: Swup, data: PageLoadOptions): void;

package/dist/types/modules/off.d.ts

@@ -1,3 +0,0 @@
-import Swup from '../Swup';
-import { EventType, Handler } from './on';
-export declare const off: (this: Swup, event?: EventType, handler?: Handler) => void;

package/dist/types/modules/on.d.ts

@@ -1,5 +0,0 @@
-import Swup from '../Swup';
-export type EventType = 'animationInDone' | 'animationInStart' | 'animationOutDone' | 'animationOutStart' | 'animationSkipped' | 'clickLink' | 'contentReplaced' | 'disabled' | 'enabled' | 'openPageInNewTab' | 'pageLoaded' | 'pageRetrievedFromCache' | 'pageView' | 'popState' | 'samePage' | 'samePageWithHash' | 'serverError' | 'transitionStart' | 'transitionEnd' | 'willReplaceContent';
-export type Handler = (event?: Event) => void;
-export type Handlers = Record<EventType, Handler[]>;
-export declare const on: (this: Swup, event: EventType, handler: Handler) => void;

package/dist/types/modules/popStateHandler.d.ts

@@ -1,2 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const popStateHandler: (this: InternalSwup, event: PopStateEvent) => void;

package/dist/types/modules/resolveUrl.d.ts

@@ -1,7 +0,0 @@
-import { InternalSwup } from '../Swup';
-/**
- * Utility function to validate and run the global option 'resolveUrl'
- * @param {string} url
- * @returns {string} the resolved url
- */
-export declare const resolveUrl: (this: InternalSwup, url: string) => string;

package/dist/types/modules/shouldIgnoreVisit.d.ts

@@ -1,4 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const shouldIgnoreVisit: (this: InternalSwup, href: string, { el }?: {
-    el?: Element | undefined;
-}) => boolean;

package/dist/types/modules/transitions.d.ts

@@ -1,6 +0,0 @@
-import Swup from '../Swup';
-export declare function updateTransition(this: Swup, from: string, to: string, custom?: string): void;
-export declare function shouldSkipTransition(this: Swup, { event }: {
-    url?: string;
-    event?: Event;
-}): boolean;

package/dist/types/modules/triggerEvent.d.ts

@@ -1,3 +0,0 @@
-import { EventType } from './on';
-import Swup from '../Swup';
-export declare const triggerEvent: (this: Swup, eventName: EventType, originalEvent?: PopStateEvent | MouseEvent) => void;

package/dist/types/modules/triggerWillOpenNewWindow.d.ts

@@ -1,2 +0,0 @@
-import { InternalSwup } from '../Swup';
-export declare const triggerWillOpenNewWindow: (this: InternalSwup, triggerEl: Element) => boolean;

package/dist/types/modules/updateTransition.d.ts

@@ -1,2 +0,0 @@
-import Swup from '../Swup';
-export declare const updateTransition: (this: Swup, from: string, to: string, custom?: string) => void;

package/readme.md

@@ -1,78 +0,0 @@
-<br>
-
-<p align="center">
-  <img width="280" alt="swup" src="https://swup.js.org/assets/images/swup-logo.svg">
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/v/swup.svg" alt="npm version"></a>
-  <a href="https://bundlephobia.com/package/swup"><img src="https://img.shields.io/bundlephobia/minzip/swup?label=size" alt="Bundle size"></a>
-  <a href="https://github.com/gmrchk/swup/blob/master/LICENSE"><img src="https://img.shields.io/github/license/gmrchk/swup.svg" alt="License"></a>
-  <a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/dt/swup.svg" alt="npm downloads"></a>
-  <a href="https://github.com/swup/swup/actions/workflows/e2e-tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/swup/swup/e2e-tests.yml?branch=master&label=tests" alt="Test status"></a>
-</p>
-
-<br>
-
-# Swup
-
-Versatile and extensible page transition library for server-side rendered websites
-
-[Features](#features) •
-[Documentation](https://swup.js.org/getting-started) •
-[Plugins](https://swup.js.org/plugins) •
-[Themes](https://swup.js.org/themes) •
-[Discussions](https://github.com/swup/swup/discussions)
-
-## Overview
-
-Swup adds page transitions to server-side rendered websites. It manages the complete lifecycle of a
-page visit by intercepting link clicks,  loading the new page in the background and smoothly
-transitioning between the old and new content.
-
-Its goal is to make it effortless to add page transitions to a site, while providing lots of other
-quality-of-life improvements.
-
-## Features
-
-- ✏️ Works out of the box with [minimal markup](https://swup.js.org/getting-started/example/)
-- ✨ Auto-detects [CSS transitions](https://swup.js.org/getting-started/how-it-works/) for perfect timing
-- 🔗 Updates URLs and preserves native [browser history](https://swup.js.org/options/#animatehistorybrowsing)
-- 🏓 Manages scroll position between pages and anchor jump links
-- 🚀 Uses a [cache](https://swup.js.org/api/cache/) to speed up subsequent page loads
-- 📡 Offers [hooks](https://swup.js.org/hooks/) to customize and extend the page load lifecycle
-- 🔌 Has a powerful [plugin system](https://swup.js.org/plugins/) and many official and third-party plugins
-- 🎨 Provides ready-to-go [themes](https://swup.js.org/themes/) to get started quickly
-
-## Plugins
-
-Swup is small by design. Extended features can be added via [plugins](https://swup.js.org/plugins/):
-
-- Display a [progress bar](https://swup.js.org/plugins/progress-plugin/) while loading
-- Enable [smooth scrolling](https://swup.js.org/plugins/scroll-plugin/) between visits
-- Update [meta tags and stylesheets](https://swup.js.org/plugins/head-plugin/) after page loads
-- Add support for [preloading pages](https://swup.js.org/plugins/preload-plugin/) in the background
-- Improve [accessibility](https://swup.js.org/plugins/a11y-plugin/) for screen readers
-- Perform your [animations in JS](https://swup.js.org/plugins/js-plugin/) instead of CSS transitions
-- Animate [form submissions](https://swup.js.org/plugins/forms-plugin/)
-- Get help in [debug mode](https://swup.js.org/plugins/debug-plugin/)
-
-Check out the list of [all official plugins](https://swup.js.org/plugins/) as well as
-[third-party integrations](https://swup.js.org/third-party-integrations/).
-
-## Examples
-
-<img src="https://user-images.githubusercontent.com/9338324/49190360-50125480-f372-11e8-89e9-d2fb091a2240.gif" width="100%">
-
-Take a look at [Sites using swup](https://github.com/swup/swup/discussions/333) for more examples.
-
-## Having trouble?
-
-If you're having trouble implementing swup, check out the [Common Issues](https://swup.js.org/other/common-issues) section of the docs, look at [closed issues](https://github.com/gmrchk/swup/issues?q=is%3Aissue+is%3Aclosed) or create a [new discussion](https://github.com/swup/swup/discussions/new).
-
-## Want to Contribute?
-
-<a href="https://github.com/swup/swup/discussions/424">We're looking for maintainers!</a>   👀
-
-Become a sponsor on [Open Collective](https://opencollective.com/swup) or support development through
-[GitHub sponsors](https://github.com/sponsors/gmrchk).

package/src/helpers/cleanupAnimationClasses.ts

@@ -1,8 +0,0 @@
-export const isSwupClass = (className: string): boolean =>
-	/^to-/.test(className) || ['is-changing', 'is-rendering', 'is-popstate'].includes(className);
-
-export const cleanupAnimationClasses = (): void => {
-	const htmlClasses = document.documentElement.className.split(' ');
-	const removeClasses = htmlClasses.filter(isSwupClass);
-	document.documentElement.classList.remove(...removeClasses);
-};

package/src/modules/loadPage.ts

@@ -1,99 +0,0 @@
-import Swup from '../Swup.js';
-import { createHistoryRecord, updateHistoryRecord, getCurrentUrl, Location } from '../helpers.js';
-import { FetchOptions } from '../modules/fetchPage.js';
-import { ContextInitOptions } from './Context.js';
-
-export type HistoryAction = 'push' | 'replace';
-
-export type PageLoadOptions = {
-	animate?: boolean;
-	transition?: string;
-	history?: HistoryAction;
-};
-
-export function loadPage(
-	this: Swup,
-	url: string,
-	options: PageLoadOptions & FetchOptions = {},
-	context: Omit<ContextInitOptions, 'to'> = {}
-) {
-	// Check if the visit should be ignored
-	if (this.shouldIgnoreVisit(url)) {
-		window.location.href = url;
-	} else {
-		const { url: to, hash } = Location.fromUrl(url);
-		this.context = this.createContext({ ...context, to, hash });
-		this.performPageLoad(to, options);
-	}
-}
-
-export async function performPageLoad(
-	this: Swup,
-	url: string,
-	options: PageLoadOptions & FetchOptions = {}
-) {
-	if (typeof url !== 'string') {
-		throw new Error(`loadPage requires a URL parameter`);
-	}
-
-	const { url: requestedUrl } = Location.fromUrl(url);
-	const { transition, animate, history: historyAction } = options;
-	options.referrer = options.referrer || this.currentPageUrl;
-
-	if (animate === false) {
-		this.context.transition.animate = false;
-	}
-	if (historyAction) {
-		this.context.history.action = historyAction;
-	}
-
-	if (!this.context.transition.animate) {
-		document.documentElement.classList.remove('is-animating');
-		this.cleanupAnimationClasses();
-	} else if (transition) {
-		this.context.transition.name = transition;
-	}
-
-	try {
-		await this.hooks.trigger('transitionStart');
-		const animationPromise = this.leavePage();
-		const pagePromise = this.hooks.trigger(
-			'loadPage',
-			{ url, options },
-			async (context, { url, options, page }) => await (page || this.fetchPage(url, options))
-		);
-
-		// create history record if this is not a popstate call (with or without anchor)
-		if (!this.context.history.popstate) {
-			const newUrl = url + (this.context.scroll.target || '');
-			if (this.context.history.action === 'replace') {
-				updateHistoryRecord(newUrl);
-			} else {
-				createHistoryRecord(newUrl);
-			}
-		}
-
-		this.currentPageUrl = getCurrentUrl();
-
-		// when everything is ready, render the page
-		const [page] = await Promise.all([pagePromise, animationPromise]);
-		this.renderPage(requestedUrl, page);
-	} catch (error: unknown) {
-		// Return early if error is undefined (probably aborted preload request)
-		if (!error) {
-			return;
-		}
-
-		// Log to console as we swallow almost all hook errors
-		console.error(error);
-
-		// Rewrite `skipPopStateHandling` to redirect manually when `history.go` is processed
-		this.options.skipPopStateHandling = () => {
-			window.location.href = requestedUrl;
-			return true;
-		};
-
-		// Go back to the actual page we're still at
-		history.go(-1);
-	}
-}