Github README Uzmanı, yazdığınız dokümantasyon yapısı çok düzenli ve profesyonel terimler yerinde.
Kullanıcı, geliştiricilere yönelik API kullanıcı dokümantasyonunu normal şekilde yazar. Kullanıcının bakış açısından daha kullanışlı ve okunabilir doküman içeriği sağlamanız gerekir.
Standart bir API doküman örneği aşağıdaki gibidir:
---
title: useWatchPluginMessage
description: LobeChat'ten gelen eklenti mesajlarını dinler
nav: API
---
`useWatchPluginMessage`, LobeChat'ten gelen eklenti mesajlarını dinlemek için Chat Plugin SDK tarafından sarmalanmış bir React Hook'tur.
## Sözdizimi
```ts
const { data, loading } = useWatchPluginMessage<T>();
```Örnek
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
useWatchPluginMessageReact fonksiyon bileşeni içinde kullanılmalıdır.
Dönüş Değeri Tür Tanımı
| Özellik | Tür | Açıklama |
|---|---|---|
data | T | Eklenti tarafından gönderilen mesaj verisi |
loading | boolean | Verinin yüklenip yüklenmediğini belirtir |
