Skip to content

Commit 1ab9d83

Browse files
committed
ui components docs
1 parent 9e8f722 commit 1ab9d83

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

ui-components.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Devup UI Components
2+
3+
If you want to use Devup UI Components, you need to install it.
4+
5+
```
6+
npm install @devup-ui/components
7+
// or
8+
yarn add @devup-ui/components
9+
// or
10+
pnpm add @devup-ui/components
11+
```
12+
13+
You need to configure the include option for each bundler environment to properly load the `@devup-ui/components` package.
14+
15+
## using Vite
16+
17+
```
18+
//vite.config.js
19+
import { defineConfig } from "vite";
20+
import react from "@vitejs/plugin-react";
21+
import { DevupUI } from "@devup-ui/vite-plugin";
22+
23+
export default defineConfig({
24+
plugins: [
25+
DevupUI({
26+
include: ["@devup-ui/components"],
27+
}),
28+
react(),
29+
],
30+
});
31+
```
32+
33+
## using Next.js
34+
35+
```
36+
// next.config.js
37+
import { DevupUI } from '@devup-ui/next-plugin'
38+
39+
export default DevupUI({ include: ["@devup-ui/components"]})
40+
```
41+
42+
## using Rsbuild
43+
44+
```
45+
// rsbuild.config.mjs
46+
import { defineConfig } from '@rsbuild/core';
47+
import { pluginReact } from '@rsbuild/plugin-react';
48+
import { DevupUIRsbuildPlugin } from '@devup-ui/rsbuild-plugin';
49+
50+
export default defineConfig({
51+
plugins: [pluginReact(), DevupUIRsbuildPlugin({
52+
include: ["@devup-ui/components"],
53+
})],
54+
});
55+
```
56+
57+
Note: If you encounter "Cannot run on the runtime" error, make sure the include option is properly configured for your bundler.
58+
59+
## Examples
60+
61+
// Form,Layout,theme etc.

0 commit comments

Comments
 (0)