Skip to content

Commit a11cb5d

Browse files
committed
docs: add docs for sender
1 parent 93ff53a commit a11cb5d

File tree

4 files changed

+50
-0
lines changed

4 files changed

+50
-0
lines changed

.changes/sender-enforce.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@matechat/react": patch:fix
3+
---
4+
5+
Enforce some styles for `Sender` component.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Sender
2+
3+
Sender is a component of textarea used to input and send messages.
4+
5+
## Examples
6+
7+
```tsx preview
8+
import { Sender } from "@matechat/react";
9+
import { useCallback, useState } from "react";
10+
11+
export default function () {
12+
return (
13+
<div className="w-full p-1">
14+
<Sender />
15+
</div>
16+
);
17+
}
18+
```
19+
20+
## Properties
21+
22+
<API moduleName="sender" />
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 输入框
2+
3+
输入框是一个 textarea 组件,用于输入和发送消息。
4+
5+
## 示例
6+
7+
```tsx preview
8+
import { Sender } from "@matechat/react";
9+
import { useCallback, useState } from "react";
10+
11+
export default function () {
12+
return (
13+
<div className="w-full p-1">
14+
<Sender />
15+
</div>
16+
);
17+
}
18+
```
19+
20+
## 参数
21+
22+
<API moduleName="sender" />

docs/rspress.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ export default defineConfig({
99
pluginApiDocgen({
1010
entries: {
1111
bubble: path.resolve(__dirname, "../src/bubble.tsx"),
12+
sender: path.resolve(__dirname, "../src/sender.tsx"),
1213
},
1314
apiParseTool: "react-docgen-typescript",
1415
}),

0 commit comments

Comments
 (0)