@sveltek/attachments/README.md

A collection of custom attachments for Svelte.

<h1 align="center">@sveltek/attachments</h1>

<p align="center">A collection of custom attachments for Svelte.</p>

<br>

> [!NOTE]
>
> Since [attachments](https://svelte.dev/docs/svelte/svelte-attachments) are a new feature in **Svelte**, this project is in an early testing phase to experiment with their implementation. As a result, breaking changes are very likely before the first stable release.
>
> If you find any issues or bugs, please [report](https://github.com/sveltek/markdown/issues/new/choose) them so the project can be improved.

<br>

## Installation

```sh
# via pnpm
pnpm add @sveltek/attachments
```

```sh
# via npm
npm install @sveltek/attachments
```

## Attachments

> **Required**: `svelte`: `>=5.29.0`

- [clickOutside](./src/attachments/click-outside/README.md) → Triggers a callback when clicking outside the target element.
- [keyboard](./src/attachments/keyboard/README.md) → Triggers a callback when a specified keyboard event occurs.
- [preventScroll](./src/attachments/prevent-scroll/README.md) → Prevents scrolling on the target element.

## License

Developed in 🇭🇷 Croatia, © Sveltek.

Released under the [MIT](LICENSE.txt) license.