npm package: @gun-vue/composables
Description: <img src="https://raw.githubusercontent.com/DeFUCC/gun-vue/main/app/public/media/svg/composables.svg" alt="@gun-vue composables logo" width="750" />
Author: davay42
Latest version: 0.25.1

# Gun-Vue: Composables

<img src="https://raw.githubusercontent.com/DeFUCC/gun-vue/main/app/public/media/svg/composables.svg" alt="@gun-vue composables logo" width="750" />

[GitHub (@gun-vue/composables)](https://github.com/DeFUCC/gun-vue/tree/main/composables) •
[npm](https://www.npmjs.com/package/@gun-vue/composables) •
[Docs](https://gun-vue.js.org/packages/composables.html) •
[API](https://gun-vue.js.org/reference/typedoc/modules.html)

Reusable logic built with the **Vue 3 Composition API** `use` functions. Manages **Gun** database interactions, **SEA** encryption, and reactive state. Check out [Gun-Vue: Features (/src)](https://github.com/DeFUCC/gun-vue/tree/main/src) for an overview.

> This code is part of [**Gun-Vue: The Peer-to-Peer Web App Toolkit**](https://github.com/DeFUCC/gun-vue).

=======

## Composables

### Identity & Access

- [**User**](https://github.com/DeFUCC/gun-vue/tree/main/src/user) - the `gun.user()` system management
- **Account** - user profile interface
- **Password** - some elaborations on reimagining password system in a p2p graph environment

### Data, Storage, & Networking

- **Crypto** - the main cryptographic primitives like e2e encrypted messaging and more
- **Date Tree** - the very performant concept of Date Tree graphs from [gun-util](https://github.com/diatche/gun-util#DateTree) made reactive and easy to use
- **Relay** - Gun relay peer connection monitoring
- **File** - some bindings to manage file uploads and downloads
- **Hash** - everything you need to hash data and work with the hashes in a reliable way (i.e. URL-safe conversion)

### Content & Collaboration

- **Chat** - Public group chat
- **Dictionary** - we find ourselves in great power if we have verified concepts to collaborate with
- **Private Messages** - E2EE Messaging
- **Posts** - hashed immutable data in the root of the db as a fun experiment, but with deep observations about freedom of speech and ways to explore the vastness of the public graph space available with Gun
- **Room** - private signed collaborative spaces with a certificate system for access management. (TBD)
- **Rooms** - cryptographic data collections
- **Space** - An endless 2D space for the users to set their positions and draw shared pictures. Can be used to meet with people and verify their identity.

### UI & Visual

- **Mouse** - some basic bindings to reliably locate mouse pointer in an SVG - may be useful for many online games

**... and more!**

## How-to Use

1. Install the library:

```shell
npm i @gun-vue/composables
```

2. Import any of the functions you need:

```js
import { useAccount } from "@gun-vue/composables";
```

3. Instantiate the function inside your Vue SFC

```js
const { account, auth, leave } = useAccount();
```

4. Use the reactive state in your template to drive the component:

```html
<div v-for="(data,field) in account.profile" :key="field">
	{{ field }} - {{ data }}
</div>
```

### SSR/SSG (Nuxt, VitePress, etc.)

Gun-Vue is client-side only and may cause errors during SSR/SSG builds. To avoid issues, consider one of these approaches:

> **Note**: We plan to refactor the code to be more usable and tree-shakeable in SSG environments. **Help needed!**

#### Approach A: Make your component async

```vue
<script setup async>
	const { useAccount } = await import("@gun-vue/composables");

	const { account } = useAccount();
</script>

<template>
	<div>{{ account.profile?.name }}</div>
</template>
```

#### Approach B: Load only on the client side

```html
<ClientOnly>
	<Suspense>
		<YourComponent />
	</Suspense>
</ClientOnly>
```

This prevents Gun-Vue from running during build time.