All files / src/internal/client render.js

98.76% Statements 321/325
93.02% Branches 40/43
100% Functions 7/7
98.71% Lines 308/312

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 3132x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 285x 285x 2x 2x 2x 2x 2x 2x 2x 17257x 17257x 17257x 17257x 10846x 10846x 10846x 17257x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1610x 1610x 1610x 1610x 1610x 1610x 1610x 1610x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1531x 1528x 3x 3x 1528x 1528x     1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1528x 1520x 1528x 1x 1x 1x 1520x 1520x 1520x 1520x 1520x 1520x 1528x 1528x 8x 3x 3x 3x 3x     3x 3x 3x 3x 3x 3x 3x 3x 5x 5x 1528x 1528x 1528x 1528x 1528x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 4039x 5057x 5057x 5057x 4165x 4165x 4165x 4165x 4165x 4165x 4165x 4165x 4165x 4165x 4165x 5057x 601x 601x 601x 601x 5057x 3564x 3564x 5057x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 4x 4x 4x 4x 3138x 3138x 2x 2x 2x 3138x 3138x 1528x 1528x 3138x 3138x 3138x 3138x 3138x 3138x 3138x 1521x 1521x 1521x 1521x 3113x 3138x 4x 4x 3138x 3138x 3138x 3102x 4066x 4066x 4066x 4066x 4066x 595x 595x 4066x 3471x 3471x 4066x 3102x 3102x 3102x 3138x 3138x 3138x 3138x 3138x 3138x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 3110x 3110x 8x 8x 8x 8x 3110x 3110x  
import { DEV } from 'esm-env';
import { clear_text_content, empty, init_operations } from './dom/operations.js';
import {
	HYDRATION_END,
	HYDRATION_ERROR,
	HYDRATION_START,
	PassiveDelegatedEvents
} from '../../constants.js';
import { flush_sync, push, pop, current_component_context, current_effect } from './runtime.js';
import { effect_root, branch } from './reactivity/effects.js';
import {
	hydrate_next,
	hydrate_node,
	hydrating,
	set_hydrate_node,
	set_hydrating
} from './dom/hydration.js';
import { array_from } from '../shared/utils.js';
import {
	all_registered_events,
	handle_event_propagation,
	root_event_handles
} from './dom/elements/events.js';
import { reset_head_anchor } from './dom/blocks/svelte-head.js';
import * as w from './warnings.js';
import * as e from './errors.js';
import { validate_component } from '../shared/validate.js';
import { assign_nodes } from './dom/template.js';
 
/**
 * This is normally true — block effects should run their intro transitions —
 * but is false during hydration (unless `options.intro` is `true`) and
 * when creating the children of a `<svelte:element>` that just changed tag
 */
export let should_intro = true;
 
/** @param {boolean} value */
export function set_should_intro(value) {
	should_intro = value;
}
 
/**
 * @param {Element} text
 * @param {string} value
 * @returns {void}
 */
export function set_text(text, value) {
	// @ts-expect-error
	const prev = (text.__t ??= text.nodeValue);
 
	if (prev !== value) {
		// @ts-expect-error
		text.nodeValue = text.__t = value;
	}
}
 
/**
 * Mounts a component to the given target and returns the exports and potentially the props (if compiled with `accessors: true`) of the component.
 * Transitions will play during the initial render unless the `intro` option is set to `false`.
 *
 * @template {Record<string, any>} Props
 * @template {Record<string, any>} Exports
 * @param {import('../../index.js').ComponentType<import('../../index.js').SvelteComponent<Props>> | import('../../index.js').Component<Props, Exports, any>} component
 * @param {{} extends Props ? {
 * 		target: Document | Element | ShadowRoot;
 * 		anchor?: Node;
 * 		props?: Props;
 * 		events?: Record<string, (e: any) => any>;
 * 		context?: Map<any, any>;
 * 		intro?: boolean;
 * 	}: {
 * 		target: Document | Element | ShadowRoot;
 * 		props: Props;
 * 		anchor?: Node;
 * 		events?: Record<string, (e: any) => any>;
 * 		context?: Map<any, any>;
 * 		intro?: boolean;
 * 	}} options
 * @returns {Exports}
 */
export function mount(component, options) {
	if (DEV) {
		validate_component(component);
	}
 
	const anchor = options.anchor ?? options.target.appendChild(empty());
	// Don't flush previous effects to ensure order of outer effects stays consistent
	return flush_sync(() => _mount(component, { ...options, anchor }), false);
}
 
/**
 * Hydrates a component on the given target and returns the exports and potentially the props (if compiled with `accessors: true`) of the component
 *
 * @template {Record<string, any>} Props
 * @template {Record<string, any>} Exports
 * @param {import('../../index.js').ComponentType<import('../../index.js').SvelteComponent<Props>> | import('../../index.js').Component<Props, Exports, any>} component
 * @param {{} extends Props ? {
 * 		target: Document | Element | ShadowRoot;
 * 		props?: Props;
 * 		events?: Record<string, (e: any) => any>;
 *  	context?: Map<any, any>;
 * 		intro?: boolean;
 * 		recover?: boolean;
 * 	} : {
 * 		target: Document | Element | ShadowRoot;
 * 		props: Props;
 * 		events?: Record<string, (e: any) => any>;
 *  	context?: Map<any, any>;
 * 		intro?: boolean;
 * 		recover?: boolean;
 * 	}} options
 * @returns {Exports}
 */
export function hydrate(component, options) {
	if (DEV) {
		validate_component(component);
	}
 
	options.intro = options.intro ?? false;
	const target = options.target;
	const was_hydrating = hydrating;
 
	try {
		// Don't flush previous effects to ensure order of outer effects stays consistent
		return flush_sync(() => {
			var anchor = /** @type {import('#client').TemplateNode} */ (target.firstChild);
			while (
				anchor &&
				(anchor.nodeType !== 8 || /** @type {Comment} */ (anchor).data !== HYDRATION_START)
			) {
				anchor = /** @type {import('#client').TemplateNode} */ (anchor.nextSibling);
			}
 
			if (!anchor) {
				throw HYDRATION_ERROR;
			}
 
			set_hydrating(true);
			set_hydrate_node(/** @type {Comment} */ (anchor));
			hydrate_next();
 
			const instance = _mount(component, { ...options, anchor });
 
			if (
				hydrate_node.nodeType !== 8 ||
				/** @type {Comment} */ (hydrate_node).data !== HYDRATION_END
			) {
				w.hydration_mismatch();
				throw HYDRATION_ERROR;
			}
 
			// flush_sync will run this callback and then synchronously run any pending effects,
			// which don't belong to the hydration phase anymore - therefore reset it here
			set_hydrating(false);
 
			return instance;
		}, false);
	} catch (error) {
		if (error === HYDRATION_ERROR) {
			// TODO it's possible for event listeners to have been added and
			// not removed, e.g. with `<svelte:window>` or `<svelte:document>`
 
			if (options.recover === false) {
				e.hydration_failed();
			}
 
			// If an error occured above, the operations might not yet have been initialised.
			init_operations();
			clear_text_content(target);
 
			set_hydrating(false);
			return mount(component, options);
		}
 
		throw error;
	} finally {
		set_hydrating(was_hydrating);
		reset_head_anchor();
	}
}
 
/** @type {Map<string, number>} */
const document_listeners = new Map();
 
/**
 * @template {Record<string, any>} Exports
 * @param {import('../../index.js').ComponentType<import('../../index.js').SvelteComponent<any>> | import('../../index.js').Component<any>} Component
 * @param {{
 * 		target: Document | Element | ShadowRoot;
 * 		anchor: Node;
 * 		props?: any;
 * 		events?: any;
 * 		context?: Map<any, any>;
 * 		intro?: boolean;
 * 	}} options
 * @returns {Exports}
 */
function _mount(Component, { target, anchor, props = {}, events, context, intro = true }) {
	init_operations();
 
	var registered_events = new Set();
 
	/** @param {Array<string>} events */
	var event_handle = (events) => {
		for (var i = 0; i < events.length; i++) {
			var event_name = events[i];
 
			if (registered_events.has(event_name)) continue;
			registered_events.add(event_name);
 
			var passive = PassiveDelegatedEvents.includes(event_name);
 
			// Add the event listener to both the container and the document.
			// The container listener ensures we catch events from within in case
			// the outer content stops propagation of the event.
			target.addEventListener(event_name, handle_event_propagation, { passive });
 
			var n = document_listeners.get(event_name);
 
			if (n === undefined) {
				// The document listener ensures we catch events that originate from elements that were
				// manually moved outside of the container (e.g. via manual portals).
				document.addEventListener(event_name, handle_event_propagation, { passive });
				document_listeners.set(event_name, 1);
			} else {
				document_listeners.set(event_name, n + 1);
			}
		}
	};
 
	event_handle(array_from(all_registered_events));
	root_event_handles.add(event_handle);
 
	/** @type {Exports} */
	// @ts-expect-error will be defined because the render effect runs synchronously
	var component = undefined;
 
	var unmount = effect_root(() => {
		branch(() => {
			if (context) {
				push({});
				var ctx = /** @type {import('#client').ComponentContext} */ (current_component_context);
				ctx.c = context;
			}
 
			if (events) {
				// We can't spread the object or else we'd lose the state proxy stuff, if it is one
				/** @type {any} */ (props).$$events = events;
			}
 
			if (hydrating) {
				assign_nodes(/** @type {import('#client').TemplateNode} */ (anchor), null);
			}
 
			should_intro = intro;
			// @ts-expect-error the public typings are not what the actual function looks like
			component = Component(anchor, props) || {};
			should_intro = true;
 
			if (hydrating) {
				/** @type {import('#client').Effect & { nodes: import('#client').EffectNodes }} */ (
					current_effect
				).nodes.end = hydrate_node;
			}
 
			if (context) {
				pop();
			}
		});
 
		return () => {
			for (var event_name of registered_events) {
				target.removeEventListener(event_name, handle_event_propagation);
 
				var n = /** @type {number} */ (document_listeners.get(event_name));
 
				if (--n === 0) {
					document.removeEventListener(event_name, handle_event_propagation);
					document_listeners.delete(event_name);
				} else {
					document_listeners.set(event_name, n);
				}
			}
 
			root_event_handles.delete(event_handle);
			mounted_components.delete(component);
		};
	});
 
	mounted_components.set(component, unmount);
	return component;
}
 
/**
 * References of the components that were mounted or hydrated.
 * Uses a `WeakMap` to avoid memory leaks.
 */
let mounted_components = new WeakMap();
 
/**
 * Unmounts a component that was previously mounted using `mount` or `hydrate`.
 * @param {Record<string, any>} component
 */
export function unmount(component) {
	const fn = mounted_components.get(component);
	if (DEV && !fn) {
		w.lifecycle_double_unmount();
		// eslint-disable-next-line no-console
		console.trace('stack trace');
	}
	fn?.();
}