svelte/attachments

import { import createAttachmentKeycreateAttachmentKey } from 'svelte/attachments';

createAttachmentKey

Disponible de puis la version 5.29

Crée une clé d’objet qui sera reconnue comme attachement lorsque l’objet sera étalé sur un élément. Ceci est une alternative programmatique à l’usage de {@attach ...}, et peut être utile aux auteurs et autrices de librairies. En revanche, createAttachmentKey ne devrait généralement pas être nécessaire si vous développez une application.

<script>
	import { createAttachmentKey } from 'svelte/attachments';

	const props = {
		class: 'cool',
		onclick: () => alert('cliqué'),
		[createAttachmentKey()]: (node) => {
			node.textContent = 'attaché !';
		}
	};
</script>

<button {...props}>cliquez-moi</button>

function createAttachmentKey(): symbol;

Attachment

Un attachement est une fonction qui est exécutée lorsqu’un élément est monté dans le DOM, et renvoie de manière optionnellement une fonction qui sera appelée lorsque l’élément sera supprimé du DOM.

Un attachement peut être attaché à un élément avec {@attach ...}, ou en étalant un objet contenant une propriété créée avec createAttachmentKey.

interface Attachment<T extends EventTarget = Element> {…}

(element: T): void | (() => void);