Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ignatiusmb/syv

Svelte Complementary Library
https://github.com/ignatiusmb/syv

complementary component headless icons library svelte

Last synced: 10 days ago
JSON representation

Svelte Complementary Library

Host: GitHub
URL: https://github.com/ignatiusmb/syv
Owner: ignatiusmb
License: mit
Created: 2020-11-21T07:58:58.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-10-22T05:32:54.000Z (16 days ago)
Last Synced: 2024-10-22T07:56:23.913Z (16 days ago)
Topics: complementary, component, headless, icons, library, svelte
Language: Svelte
Homepage: https://syv.mauss.dev
Size: 562 KB
Stars: 8
Watchers: 1
Forks: 1
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # Syv ![Total npm downloads](https://img.shields.io/npm/dt/syv) · ![Published npm version](https://img.shields.io/npm/v/syv) ![Monthly npm downloads](https://img.shields.io/npm/dm/syv) ![License](https://img.shields.io/github/license/ignatiusmb/syv) [![Made with Svelte](https://img.shields.io/badge/made%20with-Svelte-ff3e00)](https://svelte.dev/)

> The Svelte Complementary Library, a multipurpose library for working with Svelte.

-   Provides most of the essential components that are usually rewritten in a new project

    -   Need to lazy-load a component? `import LazyLoad from 'syv/core/LazyLoad.svelte';`

    -   Need to see if an element is in view? `import Observe from 'syv/core/Observe.svelte';`

-   Prepackaged customizable set of icons from various sources, import from `syv/icons`

-   Built-in loaders that are ready-to-use anywhere transitions are needed, import from `syv/loader`

-   Imports are modularized into their own namespaces and provides intuitive API for a nice usage with Svelte

-   All modules works for both client-side and server-side, no need to short-circuit or guard your code with `if (browser)`

## Usage

```bash

pnpm add -D syv

```

## API Documentation

| Module                      | Import         |

| --------------------------- | -------------- |

| [`core`](/src/lib/core)     | `'syv'`        |

| [`action`](/src/lib/api)    | `'syv/action'` |

| [`icons`](/src/lib/icons)   | `'syv/icons'`  |

| [`loader`](/src/lib/loader) | `'syv/loader'` |

| [`store`](/src/lib/store)   | `'syv/store'`  |

---

Syv | MIT License