https://github.com/mohamed-kaizen/svelteaction-docs

The docs for sveltecore, svelteshared, and svelteintegrations
https://github.com/mohamed-kaizen/svelteaction-docs

svelte svelte-action sveltejs sveltekit utilities utility

Last synced: 4 days ago
JSON representation

The docs for sveltecore, svelteshared, and svelteintegrations

• Host: GitHub
• URL: https://github.com/mohamed-kaizen/svelteaction-docs
• Owner: Mohamed-Kaizen
• Created: 2022-10-21T11:22:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-27T17:34:46.000Z (about 2 years ago)
• Last Synced: 2024-11-12T18:18:10.893Z (2 months ago)
• Topics: svelte, svelte-action, sveltejs, sveltekit, utilities, utility
• Language: Python
• Homepage: https://svelteaction.netlify.app/
• Size: 586 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Svelte Action



  





    Write less, Do more







    





    





    





    





---

**Svelte Action** is a collection of utility functions, which help you build powerful app.

The key features are:

* **Type Strong 💪**: Written in TypeScript, with full TS docs.

* **Fast to code 🚀**: Increase the speed to develop features by about 200% to 300%.

* **Fewer bugs 🐞**: Reduce about 40% of human (developer) induced errors.

* **SSR Friendly 🕺**: Works perfectly with server-side.

* **Easy 💫**: Designed to be easy to use and learn. Less time reading docs.

* **Interactive demos 🎉** : Documentation of functions also come with interactive demos!.

* **Feature Rich  🌈**: 100+ functions for you to choose from.

* **Fully 🌳 shakeable**: Only take what you want.

* **⚙️ Flexible**:  Fully customizable, configurable event filters and targets.

## Installation

### Core

```bash

pnpm add -D sveltecore

```

### Shared

```bash

pnpm add -D svelteshareds

```

### Integrations

```bash

pnpm add -D svelteintegrations

```

## 🧪 Example

### Core

``` html

import {permission} from "sveltecore"

const { state, is_supported } = permission("geolocation", {controls: true})

Is supported is: {$is_supported}

state is: {$state}

```


### Shared

``` html

import {toggleable} from "svelteshareds"

const [value, toggle] = toggleable()

value is: {$value}


Toggle

```

### Integrations

``` html

import {jwt} from "svelteintegrations/jwt"

const token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

const { header, payload } = jwt(token)

Header:

{JSON.stringify(header)}




Payload:

{JSON.stringify(payload)}

```


## 🙏 Thanks

This project is heavily inspired by the following awesome projects.

- [vueuse/vueuse](https://github.com/vueuse/vueuse/)

- [rayepps/radash](https://github.com/rayepps/radash)

## 📜 License

[MIT License](#License) © 2022-PRESENT [Mohamed Nesredin](https://github.com/mohamed-kaizen)