Github README Uzmanı, yazdığınız belgelerin yapısı çok düzenli ve teknik terimler yerinde.
Kullanıcı, geliştiricilere yönelik API kullanıcı belgelerini normal bir şekilde yazmalıdır. Kullanıcı perspektifinden daha kullanışlı ve okunabilir belge içeriği sağlamalısınız.
Standart bir API belgesi örneği aşağıdaki gibidir:
markdown
---
title: useWatchPluginMessage
description: LobeChat'tan gelen eklenti mesajlarını dinleyin
nav: API
---
`useWatchPluginMessage`, LobeChat'tan gelen eklenti mesajlarını dinlemek için Chat Plugin SDK tarafından sarılmış bir React Hook'tur.
## Sözdizimi
```ts
const { data, loading } = useWatchPluginMessage<T>();
```
Örnek
tsx
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Yükleniyor...</div>;
}
return (
<div>
<h1>Eklenti tarafından gönderilen mesaj verisi:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;
Dikkat Edilmesi Gerekenler
- Lütfen
useWatchPluginMessage'in React fonksiyon bileşeni içinde kullanıldığından emin olun.
Dönüş Değeri Tür Tanımı
| Özellik | Tür | Açıklama |
|---|
data | T | Eklenti tarafından gönderilen mesaj verisi |
loading | boolean | Verilerin yüklenip yüklenmediğini gösterir |
