@conference-kit/ui-vue 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# @conference-kit/ui-vue
|
|
2
|
+
|
|
3
|
+
Vue 3 components for conferencing UIs. Presentational only—pair with state from `@conference-kit/vue`.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @conference-kit/ui-vue
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Peer deps: Vue 3.4+, TailwindCSS 3.4+.
|
|
12
|
+
|
|
13
|
+
## Components
|
|
14
|
+
|
|
15
|
+
- `ParticipantGrid`, `ParticipantTile`
|
|
16
|
+
- `RosterList`
|
|
17
|
+
- `ControlBar`
|
|
18
|
+
- `ChatPanel`
|
|
19
|
+
- `ConnectionBadge` (exported as default)
|
|
20
|
+
|
|
21
|
+
Each component accepts props mirroring the React UI kit (IDs, labels, media streams, connection status, handler callbacks).
|
|
22
|
+
|
|
23
|
+
## Quick example
|
|
24
|
+
|
|
25
|
+
```vue
|
|
26
|
+
<script setup lang="ts">
|
|
27
|
+
import { ParticipantGrid, ConnectionBadge } from "@conference-kit/ui-vue";
|
|
28
|
+
|
|
29
|
+
const participants = [
|
|
30
|
+
{
|
|
31
|
+
id: "me",
|
|
32
|
+
label: "You",
|
|
33
|
+
stream: null,
|
|
34
|
+
connectionState: "connected",
|
|
35
|
+
isLocal: true,
|
|
36
|
+
},
|
|
37
|
+
];
|
|
38
|
+
const status = { signaling: "open", media: "ready", data: "ready" };
|
|
39
|
+
</script>
|
|
40
|
+
|
|
41
|
+
<template>
|
|
42
|
+
<div class="space-y-4">
|
|
43
|
+
<ConnectionBadge :status="status" />
|
|
44
|
+
<ParticipantGrid :participants="participants" />
|
|
45
|
+
</div>
|
|
46
|
+
</template>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Build
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
npm run build
|
|
53
|
+
```
|