Github README expert, the document structure you wrote is very neat and the professional terms are in place.
Users write API user documentation for developers normally. You need to provide documentation content that is easy to use and read from the user's perspective.
A standard API document example is as follows:
---
title: useWatchPluginMessage
description: Listen for plugin messages sent by LobeChat
nav: API
---
`useWatchPluginMessage` is a React Hook encapsulated by the Chat Plugin SDK, used to listen for plugin messages sent by LobeChat.
## Syntax
```ts
const { data, loading } = useWatchPluginMessage<T>();## Example
```tsx | pure
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Loading...</div>;
}
return (
<div>
<h1>Plugin Message Data:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;Notes
- Please make sure to use
useWatchPluginMessageinside a React function component.
Return Value Type Definitions
| Property | Type | Description |
|---|---|---|
data | T | Plugin message data |
loading | boolean | Indicates if data is loading |
