Yuva chat hook

A React hook over the useyuva headless client for live chat: the session, conversation list, one thread with realtime messages, typing, read state, sending text and files, rating and attachment download. Labels with English defaults.

プレビューはサンプルデータで動作します。ネットワークもチャネルも不要です。

tsx

import { useYuvaChat } from "@/hooks/use-yuva-chat"

export function Inbox() {
  const chat = useYuvaChat({
    server={process.env.NEXT_PUBLIC_YUVA_SERVER}
    channel={process.env.NEXT_PUBLIC_YUVA_CHANNEL},
  })

  return (
    <ul>
      {chat.conversations.map((conversation) => (
        <li key={conversation.id}>
          <button onClick={() => void chat.open(conversation.id)}>{conversation.subject}</button>
        </li>
      ))}
    </ul>
  )
}

インストール

shadcn プロジェクトで実行してください。ファイルはあなた自身のコードにコピーされます。

Shell

npx shadcn@latest add https://useyuva.com/r/use-yuva-chat.json

Shell

pnpm dlx shadcn@latest add https://useyuva.com/r/use-yuva-chat.json

Shell

yarn dlx shadcn@latest add https://useyuva.com/r/use-yuva-chat.json

Shell

bunx --bun shadcn@latest add https://useyuva.com/r/use-yuva-chat.json

使い方

tsx

import { useYuvaChat } from "@/hooks/use-yuva-chat"

const chat = useYuvaChat({ server, channel })

Props

`UseYuvaChatOptions`

Prop	型
`server?`	`string`
`channel?`	`string`
`client?`	`YuvaClient`
`identityToken?`	`IdentityTokenSource \| null`
`helpArticleId?`	`string`

`YuvaChatState`

Prop	型
`loading`	`boolean`
`error`	`unknown`
`inbox`	`ClientInbox \| null`
`contact`	`ClientContact \| null`
`connection`	`ConnectionState["state"]`
`conversations`	`ClientConversation[]`
`hasMoreConversations`	`boolean`
`loadMoreConversations`	`() => Promise<void>`
`activeId`	`string \| null`
`conversation`	`ClientConversation \| null`
`open`	`(id: string \| null) => Promise<void>`
`removed`	`boolean`
`threadLoading`	`boolean`
`messages`	`YuvaChatMessage[]`
`hasEarlier`	`boolean`
`loadEarlier`	`() => Promise<void>`
`typing`	`ClientMessage["author"] \| null`
`memberReadAt`	`string \| null`
`send`	`(input: YuvaChatSendInput) => Promise<void>`
`retry`	`(id: string) => Promise<void>`
`discard`	`(id: string) => void`
`setTyping`	`(on: boolean) => void`
`markRead`	`() => Promise<void>`
`rate`	`(rating: Rating, comment?: string) => Promise<void>`
`openAttachment`	`(attachment: ClientAttachment) => Promise<void>`
`saveEmail`	`(email: string) => Promise<void>`

依存関係

この項目をインストールすると、次のものも追加されます。

npm パッケージ

useyuva ↗

← 前へYuva idea suggest form 次へ →Yuva discussions hooks