Skip to content

Commit 1fea3ee

Browse files
committed
docs: readme
1 parent e6be380 commit 1fea3ee

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

packages/omi-weui/README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,36 @@
33
OMI 版本 WeUI 是一套同微信原生视觉体验一致的基础样式库,由微信官方设计团队为微信内网页和微信小程序量身设计,令用户的使用感知更加统一。
44

55

6-
## Installation
6+
## 安装
77

88
```bash
99
npm i omi-weui
1010
```
1111

12-
## Usage
12+
## 使用
1313

1414
```tsx
15-
import '@omi-weui/button'
15+
import { WeButton } from 'omi-weui'
16+
WeButton.define('we-button')
1617
```
1718

1819
在各个框架中使用:
1920

2021
```tsx
21-
<w-button>按钮</w-button> // omi
22-
<w-button>按钮</w-button> // vue
23-
<w-button>按钮</w-button> // html
22+
<we-button type="warn">按钮</we-button> // omi
23+
<we-button size="mini">按钮</we-button> // vue
24+
<we-button type="default">按钮</we-button> // react
25+
<we-button loading>按钮</we-button> // html
2426
```
27+
或者直接:
28+
29+
```tsx
30+
const btn = document.createElement('we-button')
31+
btn.innerText = '按钮'
32+
document.body.appendChild(btn)
33+
```
34+
35+
2536

2637
## License
2738

0 commit comments

Comments
 (0)