tencent/tdesign-react
tencent/tdesign-react
1
0
Fork 0
mirror of https://github.com/Tencent/tdesign-react.git synced 2024-10-23 08:33:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update usage docs for nextjs (#3138)

Browse Source
This commit is contained in:
wū yāng 2024-10-15 12:17:52 +08:00 committed by GitHub
parent 097a9fb3ec
commit 7e0bd734b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
site/docs/getting-started.en-US.md
View File

@ -18,6 +18,7 @@ npm i tdesign-react
<link rel="stylesheet" href="https://unpkg.com/tdesign-react/dist/tdesign.min.css" />
<script src="https://unpkg.com/tdesign-react/dist/tdesign.min.js"></script>
```
> Please note that unpkg usage is not recommended as it will download the entire component library. Production projects will be directly affected by version updates, and may also be affected by the stability of the CDN.
The package of tdesign-react provides kinds of bundles, read [the documentation](https://github.com/Tencent/tdesign/blob/main/docs/develop-install.md) for the detail of differences between bundles.
@ -92,6 +93,8 @@ module.exports = {
When using Next.js, you need to adjust how you use these components.
```js
'use client'
import { Button } from 'tdesign-react/lib/';
import 'tdesign-react/dist/tdesign.css';
```

3
site/docs/getting-started.md
View File

@ -22,6 +22,7 @@ npm i tdesign-react
<link rel="stylesheet" href="https://unpkg.com/tdesign-react/dist/tdesign.min.css" />
<script src="https://unpkg.com/tdesign-react/dist/tdesign.min.js"></script>
```
> 请注意，我们不推荐使用这种方式，这样无法实现按需加载等优化手段，生产项目会直接受版本更新影响，同时也可能受到 CDN 的稳定性的影响。
npm package 中提供了多种构建产物，可以阅读 [这里](https://github.com/Tencent/tdesign/blob/main/docs/develop-install.md) 了解不同目录下产物的差别。
@ -96,6 +97,8 @@ module.exports = {
所以在 `next.js` 中需要调整下使用方式：
```js
'use client'
import { Button } from 'tdesign-react/lib/'; // 按需引入无样式组件代码
import 'tdesign-react/dist/tdesign.css'; // 全局引入所有组件样式代码
```