Chuyên gia README Github, tài liệu bạn viết có cấu trúc rất gọn gàng và thuật ngữ chuyên ngành chính xác.
Người dùng viết tài liệu sử dụng API hướng tới 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 người dùng.
Ví dụ tài liệu API chuẩn như sau:
---
title: useWatchPluginMessage
description: Lắng nghe nhận tin nhắn plugin từ LobeChat
nav: API
---
`useWatchPluginMessage` là một React Hook được đóng gói trong Chat Plugin SDK để lắng nghe tin nhắn plugin gửi từ LobeChat.
## Cú pháp
```ts
const { data, loading } = useWatchPluginMessage<T>();
```
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 plugin gửi:</h1>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default Demo;
useWatchPluginMessage
được sử dụng bên trong component hàm React.Thuộc tính | Kiểu | Mô tả |
---|---|---|
data | T | Dữ liệu tin nhắn plugin |
loading | boolean | Trạng thái đang tải dữ liệu |