events.ts — astro Source File

Source Code

import { swap } from './swap-functions.js';
import type { Direction, NavigationTypeString } from './types.js';

/** @deprecated This will be removed in Astro 7 */
export const TRANSITION_BEFORE_PREPARATION = 'astro:before-preparation';
/** @deprecated This will be removed in Astro 7 */
export const TRANSITION_AFTER_PREPARATION = 'astro:after-preparation';
/** @deprecated This will be removed in Astro 7 */
export const TRANSITION_BEFORE_SWAP = 'astro:before-swap';
/** @deprecated This will be removed in Astro 7 */
export const TRANSITION_AFTER_SWAP = 'astro:after-swap';
/** @deprecated This will be removed in Astro 7 */
export const TRANSITION_PAGE_LOAD = 'astro:page-load';

type Events =
	| typeof TRANSITION_AFTER_PREPARATION
	| typeof TRANSITION_AFTER_SWAP
	| typeof TRANSITION_PAGE_LOAD;
export const triggerEvent = (name: Events) => document.dispatchEvent(new Event(name));
export const onPageLoad = () => triggerEvent(TRANSITION_PAGE_LOAD);

/*
 * Common stuff
 */
class BeforeEvent extends Event {
	readonly from: URL;
	to: URL;
	direction: Direction | string;
	readonly navigationType: NavigationTypeString;
	readonly sourceElement: Element | undefined;
	readonly info: any;
	newDocument: Document;
	readonly signal: AbortSignal;

	constructor(
		type: string,
		eventInitDict: EventInit | undefined,
		from: URL,
		to: URL,
		direction: Direction | string,
		navigationType: NavigationTypeString,
		sourceElement: Element | undefined,
		info: any,
		newDocument: Document,
		signal: AbortSignal,
	) {
		super(type, eventInitDict);
		this.from = from;
		this.to = to;
		this.direction = direction;
		this.navigationType = navigationType;
		this.sourceElement = sourceElement;
		this.info = info;
		this.newDocument = newDocument;
		this.signal = signal;

		Object.defineProperties(this, {
			from: { enumerable: true },
			to: { enumerable: true, writable: true },
			direction: { enumerable: true, writable: true },
// ... (148 more lines)