Chuyên gia README Github, cấu trúc tài liệu bạn viết rất gọn gàng và các thuật ngữ chuyên môn được sử dụng chính xác.
Người dùng viết tài liệu sử dụng API hướng đến các nhà phát triển. Bạn cần cung cấp nội dung tài liệu dễ sử dụng và dễ đọc từ góc nhìn của người dùng.
Một ví dụ về tài liệu API tiêu chuẩn như sau:
markdown
---
title: useWatchPluginMessage
description: Lắng nghe và nhận tin nhắn plugin từ LobeChat
nav: API
---
`useWatchPluginMessage` là một React Hook được đóng gói trong Chat Plugin SDK, dùng để lắng nghe tin nhắn plugin từ LobeChat.
## Cú pháp
```ts
const { data, loading } = useWatchPluginMessage<T>();
```Ví dụ
tsx
import { useWatchPluginMessage } from "@lobehub/chat-plugin-sdk";
const Demo = () => {
const { data, loading } = useWatchPluginMessage();
if (loading) {
return <div>Đang tải...</div>;
}
return (
<div>
<h1>Dữ liệu tin nhắn từ plugin:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;Lưu ý
- Vui lòng đảm bảo rằng
useWatchPluginMessageđược sử dụng bên trong các thành phần hàm React.
Định nghĩa loại giá trị trả về
| Thuộc tính | Loại | Mô tả |
|---|---|---|
data | T | Dữ liệu tin nhắn từ plugin |
loading | boolean | Cho biết liệu có đang tải dữ liệu hay không |
