syv
v0.0.53
Published
practical svelte components and utilities
Maintainers
ignatiusmbReadme
syv
practical svelte components and utilities
syv is a minimal yet powerful utility library for Svelte — built from patterns I found myself rewriting again and again. It offers a focused set of essential building blocks for UI and app logic, organized by namespace for clean imports, and fully compatible with both client and server, without needing to guard with if (browser).
pnpm add -D syv| Module | Import |
| -------------------------------------------- | ----------------------- |
| core | 'syv' |
| core/*.svelte | 'syv/core/*.svelte' |
| attachment | 'syv/attachment' |
| loader/*.svelte | 'syv/loader/*.svelte' |
| worker | 'syv/worker' |
| options | 'syv/options' |
| types | 'syv/types' |
API
syv/worker - commander/spawn
The /worker submodule provides commander and spawn functions for creating and managing web workers in Svelte, along with a generic Dispatch to generate the type-safe commands. Use commander to register commands that the worker can handle, and spawn to create the worker instance in your .svelte file.
// file: src/routes/search.worker.ts
// note: having `.worker` in the filename is optional
// it just helps us identify the file as a worker
import { commander, type Dispatch } from 'syv/worker';
// example of a command payload
type Query = {
search: string;
category: string;
genres: string[];
sort_by: 'newest' | 'oldest' | 'popular';
};
interface Item {
title: string;
description: string;
// other properties
}
let dataset: Item[] = [];
const commands = {
init(payload: Item[]) {
dataset = payload;
return true;
},
search(payload: Query) {
// @TODO: do your search logic here
// `sift` is the helper function
return sift(dataset, payload);
},
};
export type Commands = Dispatch<typeof commands>;
addEventListener('message', commander(commands));with the worker file defined with the commander, you can now use it in your Svelte component. since Vite worker detection only works with statically analyzed new Worker(new URL('./worker'), import.meta.url), we'll import the worker with query suffixes to ensure it is not inlined as base64 strings and treated as a worker file.
<!-- file: src/routes/+page.svelte -->
<script lang="ts">
import type { Commands } from './search.worker';
import { spawn } from 'syv/worker';
import worker from './search.worker?worker&url';
const { data } = $props();
// do not call `invoke` directly in the script tag, it will
// throw a "Worker not ready" error unless you disable SSR.
const invoke = spawn<Commands>(worker, (invoke) => invoke('init', data.items));
let index = $state(data.items);
</script>
<!-- use `invoke` anywhere inside a function in your markup -->
<SearchBar
value={data.query}
oninput={async (value) => {
index = await invoke('search', value);
}}
/>*.svelte
syv/core/MetaHead.svelte
A Svelte component for managing meta tags and custom scripts in the <head> of your document. Designed to live in your root +layout.svelte, it automatically handles metadata like title, description, canonical, and alternate links.
It also supports conditionally loading any external scripts for analytics, performance tracking, and more. Just pass the script URLs and attributes via the scripts prop; only entries with truthy values will be included, this is useful for conditionally loading scripts in development or production environments.
<!-- file: src/routes/+layout.svelte -->
<script>
import MetaHead from 'syv/core/MetaHead.svelte';
// `dev` and `afterNavigate` are optional, only for loading scripts
import { dev } from '$app/environment';
import { afterNavigate } from '$app/navigation';
import { page } from '$app/state';
afterNavigate(() => {
// @ts-expect-error - optional, if you use Vercel Analytics in the scripts
window.va?.('pageview', { route: page.route.id, url: page.url.pathname });
});
</script>
<MetaHead
domain="https://<YOUR_DOMAIN>"
title="{page.data.meta?.title || page.status} | <YOUR_SITE_NAME>"
canonical={page.data.meta?.canonical}
description={page.data.meta?.description}
authors={['<YOUR_NAME>']}
alternate={[
{ type: 'application/rss+xml', href: '/rss.xml', title: 'RSS Feed' },
]}
scripts={{
'/_vercel/insights/script.js': !dev && { 'data-disable-auto-track': '1' },
'/_vercel/speed-insights/script.js': !dev && { 'data-route': page.route.id },
'https://static.cloudflareinsights.com/beacon.min.js': !dev && {
'data-cf-beacon': '{"token": "<YOUR_CF_TOKEN>"}',
},
}}
>
<!-- optionally, define any additional tags manually if you need it -->
</MetaHead>syv/core/Dialog.svelte
<!-- file: src/lib/MyDialog.svelte -->
<script lang="ts">
import Dialog from 'syv/core/Dialog.svelte';
import type { ComponentProps } from 'svelte';
interface Props extends Omit<ComponentProps<typeof Dialog>, 'children'> {
// your own props
}
let props: Props = $props();
</script>
<Dialog
{...props}
styles={{
'--backdrop-filter': 'none', // or 'blur(10px)' for a blurred background
'--background': 'var(--color-base)', // use your own css variables
'--border-radius': 'var(--rounding-box)', // same as above
'--padding': '1rem 1.5rem 1.5rem', // adjust padding as needed
}}
>
<!-- structure your own dialog content here -->
<button onclick={props.onclose}>close</button>
</Dialog>
<style>
/* style your own dialog */
</style>