Add tiktok-live-nuxt
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 354
- Avg merge
- 10h 18m
- Merged PRs (30d)
- 12
Description
Module Info
- Name: tiktok-live-nuxt
- npm: https://www.npmjs.com/package/tiktok-live-nuxt
- Repository: https://github.com/tiktool/tiktok-live-nuxt
- Category: Integration
- Description: Nuxt module for TikTok LIVE API - real-time chat, gifts, viewers, battles & AI captions via WebSocket
Features
- Auto-imported
useTikTokLive()composable - Reactive refs for chat messages, gifts, viewer count
- SSR-safe (WebSocket connects on client hydration)
- Custom event handlers via
.on() - Config via
nuxt.config.tsorTIKTOOL_API_KEYenv var - TypeScript support with full type definitions
- Works with Nuxt 3+
Quick Example
<script setup>
const { messages, viewers, gifts, connected } = useTikTokLive('gbnews')
</script>
<template>
<div>
<p>👀 {{ viewers }} viewers</p>
<div v-for="msg in messages" :key="msg.data?.msgId">
{{ msg.data?.user?.uniqueId }}: {{ msg.data?.comment }}
</div>
</div>
</template>
Links
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the nuxt/modules repository's contribution guidance and existing integration module entries, then compare the submitted metadata with the linked npm package, repository, and documentation. Done means the tiktok-live-nuxt module is added consistently with the repository's existing catalog format and its links and description are accurate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nuxt, typescript
- Domain
- frontend, web-dev
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100