Github README-Experte, Ihre Dokumentationsstruktur ist sehr ordentlich und die Fachbegriffe sind präzise.
Der Benutzer schreibt normale API-Benutzerdokumentation für Entwickler. Sie müssen aus der Sicht des Benutzers eine benutzerfreundliche und leicht verständliche Dokumentation bereitstellen.
Ein Standard-API-Dokumentationsbeispiel sieht wie folgt aus:
markdown
---
title: useWatchPluginMessage
description: Überwacht Plugin-Nachrichten, die von LobeChat gesendet werden
nav: API
---
`useWatchPluginMessage` ist ein von Chat Plugin SDK gekapselter React Hook, der Plugin-Nachrichten von LobeChat überwacht.
## Syntax
```ts
const { data, loading } = useWatchPluginMessage<T>();
```Beispiel
tsx
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Lädt...</div>;
}
return (
<div>
<h1>Vom Plugin gesendete Nachrichtendaten:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;Hinweise
- Bitte stellen Sie sicher, dass
useWatchPluginMessageinnerhalb einer React-Funktionskomponente verwendet wird.
Definition der Rückgabewerttypen
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
data | T | Vom Plugin gesendete Nachrichtendaten |
loading | boolean | Gibt an, ob Daten geladen werden |
