vxui-react 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +29 -2
- package/README.md +29 -2
- package/dist/index.cjs +2 -2
- package/dist/index.js +36 -38
- package/dist/src/components/Dialog.d.ts +3 -1
- package/dist/src/components/Toast.d.ts +2 -7
- package/dist/vxui-react.css +1 -1
- package/llms.txt +303 -0
- package/package.json +4 -3
package/README.en.md
CHANGED
|
@@ -1,10 +1,17 @@
|
|
|
1
|
-
# VXUI React · v1.3.
|
|
1
|
+
# VXUI React · v1.3.3
|
|
2
2
|
|
|
3
3
|
**Website**: [ui.vx.link](https://ui.vx.link) | **GitHub**: [tmplink/vxui_react](https://github.com/tmplink/vxui_react) | [中文](README.md)
|
|
4
4
|
|
|
5
5
|
VXUI React is a general-purpose React UI component library designed for admin panels, ops dashboards, internal tools, and data-heavy interfaces.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## 🚀 Changelog
|
|
8
|
+
|
|
9
|
+
> **v1.3.3** — 2025-05
|
|
10
|
+
> - Added [`llms.txt`](llms.txt) — AI knowledge base file for AI tools to read component documentation directly
|
|
11
|
+
> - Bundle size optimization, removed redundant dependencies
|
|
12
|
+
> - Fixed style compatibility issues across multiple components
|
|
13
|
+
|
|
14
|
+
See full changelog at [GitHub Releases](https://github.com/tmplink/vxui_react/releases).
|
|
8
15
|
|
|
9
16
|
The documentation follows the conventions of popular UI frameworks: installation first, then a minimal working example, then scenario-specific component code.
|
|
10
17
|
|
|
@@ -186,6 +193,26 @@ Use `useTheme()` at runtime to read the current theme or call `setTheme('ocean')
|
|
|
186
193
|
- **Forms**: Input, Select, Checkbox, Radio, Textarea, Slider, Switch, NumberInput, TagInput, ColorPicker, DatePicker, FileUpload, Form, Rating
|
|
187
194
|
- **Feedback**: Alert, AlertDialog, Toast, Progress, Skeleton, Spinner, Stepper, Timeline, EmptyState
|
|
188
195
|
- **Overlay**: Dialog, Sheet, Popover, DropdownMenu, ContextMenu, Tooltip, HoverCard, CommandPalette, Menubar, NavigationMenu
|
|
196
|
+
|
|
197
|
+
### Dialog Props
|
|
198
|
+
|
|
199
|
+
| Prop | Type | Default | Description |
|
|
200
|
+
|------|------|---------|-------------|
|
|
201
|
+
| trigger | ReactNode | **required** | Element that triggers opening the dialog |
|
|
202
|
+
| title | string | **required** | Dialog title |
|
|
203
|
+
| description | string | — | Optional description below the title |
|
|
204
|
+
| children | ReactNode | **required** | Dialog body content |
|
|
205
|
+
| footer | ReactNode | — | Footer action area |
|
|
206
|
+
| size | 'sm' \| 'md' \| 'lg' \| 'xl' \| 'full' | 'md' | Width preset |
|
|
207
|
+
| placement | 'center' \| 'top' \| 'right' \| 'bottom' \| 'left' \| 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right' \| 'top-half' \| 'right-half' \| 'bottom-half' \| 'left-half' | 'center' | Screen position (desktop only) |
|
|
208
|
+
| padding | 'none' \| 'sm' \| 'md' \| 'lg' | 'md' | Inner padding preset |
|
|
209
|
+
| scrollable | boolean | true | Enable scroll when content overflows |
|
|
210
|
+
| closable | boolean | true | Show close button (×) |
|
|
211
|
+
| **fullscreen** | **boolean** | **false** | **Fullscreen mode: occupies the entire viewport, ideal for mobile devices** |
|
|
212
|
+
| className | string | — | Additional CSS class |
|
|
213
|
+
| defaultOpen | boolean | false | Whether the dialog is open by default |
|
|
214
|
+
| open | boolean | — | Controlled open state |
|
|
215
|
+
| onOpenChange | (open: boolean) => void | — | Open state change handler |
|
|
189
216
|
- **Data Display**: Avatar, Table, Badge, Tabs, Accordion, TreeView, Carousel, Calendar
|
|
190
217
|
- **Typography**: Heading, Text, Label, CodeBlock
|
|
191
218
|
- **Mobile**: MobileShell, BottomNav, ActionSheet, MobileDrawer, MobileList
|
package/README.md
CHANGED
|
@@ -1,10 +1,17 @@
|
|
|
1
|
-
# VXUI React · v1.3.
|
|
1
|
+
# VXUI React · v1.3.3
|
|
2
2
|
|
|
3
3
|
**官网**:[ui.vx.link](https://ui.vx.link) | **GitHub**:[tmplink/vxui_react](https://github.com/tmplink/vxui_react) | [English](README.en.md)
|
|
4
4
|
|
|
5
5
|
VXUI React 是一套适合后台、运营台、仪表盘和内部工具的通用 UI 组件库。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## 🚀 更新公告
|
|
8
|
+
|
|
9
|
+
> **v1.3.3** — 2025-05
|
|
10
|
+
> - 新增 [`llms.txt`](llms.txt) — AI 知识库文件,AI 工具可直接读取以获取组件文档
|
|
11
|
+
> - 包体积优化,移除了冗余依赖
|
|
12
|
+
> - 修复了多个组件的样式兼容性问题
|
|
13
|
+
|
|
14
|
+
查看完整更新日志请访问 [GitHub Releases](https://github.com/tmplink/vxui_react/releases)。
|
|
8
15
|
|
|
9
16
|
文档内容现在按流行 UI 框架的写法组织:先给安装方式,再给最小可运行示例,最后给分场景的组件代码。
|
|
10
17
|
|
|
@@ -188,6 +195,26 @@ export function Root({ children }: { children: React.ReactNode }) {
|
|
|
188
195
|
- **Forms**: Input、Select、Checkbox、Radio、Textarea、Slider、Switch、NumberInput、TagInput、ColorPicker、DatePicker、FileUpload、Form、Rating
|
|
189
196
|
- **Feedback**: Alert、AlertDialog、Toast、Progress、Skeleton、Spinner、Stepper、Timeline、EmptyState
|
|
190
197
|
- **Overlay**: Dialog、Sheet、Popover、DropdownMenu、ContextMenu、Tooltip、HoverCard、CommandPalette、Menubar、NavigationMenu
|
|
198
|
+
|
|
199
|
+
### Dialog 属性
|
|
200
|
+
|
|
201
|
+
| 属性 | 类型 | 默认值 | 说明 |
|
|
202
|
+
|------|------|--------|------|
|
|
203
|
+
| trigger | ReactNode | 必填 | 触发打开对话框的元素 |
|
|
204
|
+
| title | string | 必填 | 对话框标题 |
|
|
205
|
+
| description | string | — | 标题下方的描述文字 |
|
|
206
|
+
| children | ReactNode | 必填 | 对话框内容 |
|
|
207
|
+
| footer | ReactNode | — | 底部操作区 |
|
|
208
|
+
| size | 'sm' \| 'md' \| 'lg' \| 'xl' \| 'full' | 'md' | 宽度预设 |
|
|
209
|
+
| placement | 'center' \| 'top' \| 'right' \| 'bottom' \| 'left' \| 'top-left' \| 'top-right' \| 'bottom-left' \| 'bottom-right' \| 'top-half' \| 'right-half' \| 'bottom-half' \| 'left-half' | 'center' | 屏幕位置(仅桌面端) |
|
|
210
|
+
| padding | 'none' \| 'sm' \| 'md' \| 'lg' | 'md' | 内边距预设 |
|
|
211
|
+
| scrollable | boolean | true | 内容溢出时是否可滚动 |
|
|
212
|
+
| closable | boolean | true | 是否显示关闭按钮(×) |
|
|
213
|
+
| **fullscreen** | **boolean** | **false** | **全屏模式:启用后对话框将占据整个视口,适用于移动设备** |
|
|
214
|
+
| className | string | — | 额外 CSS 类名 |
|
|
215
|
+
| defaultOpen | boolean | false | 默认是否打开 |
|
|
216
|
+
| open | boolean | — | 受控打开状态 |
|
|
217
|
+
| onOpenChange | (open: boolean) => void | — | 打开状态变化回调 |
|
|
191
218
|
- **Data Display**: Avatar、Table、Badge、Tabs、Accordion、TreeView、Carousel、Calendar
|
|
192
219
|
- **Typography**: Heading、Text、Label、CodeBlock
|
|
193
220
|
- **Mobile**: MobileShell、BottomNav、ActionSheet、MobileDrawer、MobileList
|