Skip to main content

svelte/attachments

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

createAttachmentKey

自 5.29 版本起可用

¥Available since 5.29

创建一个对象键,当对象展开到元素上时,该键将被识别为附件,这是使用 {@attach ...} 的编程替代方案。这对库作者来说很有用,但在构建应用时通常不需要。

¥Creates an object key that will be recognised as an attachment when the object is spread onto an element, as a programmatic alternative to using {@attach ...}. This can be useful for library authors, though is generally not needed when building an app.

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

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

<button {...props}>click me</button>
function createAttachmentKey(): symbol;

附件(Attachment)

¥Attachment

attachment 是一个函数,在元素挂载到 DOM 时运行,并可选地返回一个函数,该函数在元素稍后被移除时被调用。

¥An attachment is a function that runs when an element is mounted to the DOM, and optionally returns a function that is called when the element is later removed.

它可以通过 {@attach ...} 标签附加到元素,或者通过展开包含使用 createAttachmentKey 创建的属性的对象来附加。

¥It can be attached to an element with an {@attach ...} tag, or by spreading an object containing a property created with createAttachmentKey.

interface Attachment<T extends EventTarget = Element> {}
(element: T): void | (() => void);
上一页 下一页