Getting Started

Svelte Utility is a collection of utility functions that can be used in your Svelte projects. It's divided into multiple packages, each with their own focus:

• actions: A collection of Svelte actions. Because svelte actions work in browser context, these actions are only available in the browser.
• browser: A collection of function that are only available in the browser.
• extend: A collection of integrations with 3rd party libraries.
• shared: A shared module that is used by the other packages.

Fully Typed

The functions in this library are fully typed, which means that they have explicit types for their parameters and return values. This makes them easy to use in TypeScript or JavaScript projects, as the type checker can ensure that the functions are used correctly. The functions are also fully documented, which means that they have detailed descriptions of their purpose, parameters, and return values. This makes them easy to use in your IDE, as you can get help with the functions' syntax and usage.

Installation

First pick the package you want to install. For example, if you want to use the snapshot action, you'll need to install the actions, etc.

Actions

npm install --save @sveu/actions

npm install --save @sveu/actions

Browser

npm install --save @sveu/browser

npm install --save @sveu/browser

Extend

npm install --save @sveu/extend

npm install --save @sveu/extend

Shared

npm install --save @sveu/shared

npm install --save @sveu/shared

Usage

The packages are designed to be tree-shakeable, so you can import only the functions you need. For example, if you want to use the snapshot action, you can import it like this:

import { snapshot } from "@sveu/actions"

import { snapshot } from "@sveu/actions"

If you want to use multiple functions from the same package, you can import them all at once:

import { dropzone, snapshot } from "@sveu/actions"

import { dropzone, snapshot } from "@sveu/actions"

If you want to use multiple functions from different packages, you can import them like this:

import { snapshot } from "@sveu/actions"
import { mouse } from "@sveu/browser"

import { snapshot } from "@sveu/actions"
import { mouse } from "@sveu/browser"