straw-ui-vue 0.1.15 → 0.1.17
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.md +56 -114
- package/dist/cn-CiflBmGp.js +1763 -0
- package/dist/components/st-card/index.d.ts +228 -0
- package/dist/components/st-card/st-card-group-action.d.ts +11 -0
- package/dist/components/st-card/st-card-group-content.d.ts +11 -0
- package/dist/components/st-card/st-card-group-description.d.ts +11 -0
- package/dist/components/st-card/st-card-group-footer.d.ts +11 -0
- package/dist/components/st-card/st-card-group-header.d.ts +11 -0
- package/dist/components/st-card/st-card-group-title.d.ts +11 -0
- package/dist/components/st-card/st-card-group.d.ts +11 -0
- package/dist/components/st-card/st-card.d.ts +11 -0
- package/dist/components/st-card/types.d.ts +184 -0
- package/dist/components/st-cascade/st-cascade.d.ts +1 -1
- package/dist/components/st-color-picker/st-color-picker-panel.d.ts +1 -1
- package/dist/components/st-date-picker/st-date-picker.d.ts +1 -1
- package/dist/components/st-datetime-picker/st-datetime-picker.d.ts +1 -1
- package/dist/components/st-datetime-picker/types.d.ts +0 -1
- package/dist/components/st-dialog/context.d.ts +6 -0
- package/dist/components/st-dialog/index.d.ts +189 -242
- package/dist/components/st-dialog/st-dialog-group-action.d.ts +11 -0
- package/dist/components/st-dialog/st-dialog-group-body.d.ts +9 -0
- package/dist/components/st-dialog/st-dialog-group-content.d.ts +11 -0
- package/dist/components/st-dialog/st-dialog-group-draggable.d.ts +13 -0
- package/dist/components/st-dialog/st-dialog-group-footer.d.ts +11 -0
- package/dist/components/st-dialog/st-dialog-group-header.d.ts +19 -0
- package/dist/components/st-dialog/st-dialog-group-overlay.d.ts +9 -0
- package/dist/components/st-dialog/st-dialog-group-title.d.ts +11 -0
- package/dist/components/st-dialog/st-dialog-group.d.ts +13 -0
- package/dist/components/st-dialog/st-dialog.d.ts +8 -14
- package/dist/components/st-dialog/types.d.ts +235 -101
- package/dist/components/st-drawer/context.d.ts +6 -0
- package/dist/components/st-drawer/index.d.ts +263 -57
- package/dist/components/st-drawer/st-drawer-group-action.d.ts +11 -0
- package/dist/components/st-drawer/st-drawer-group-body.d.ts +9 -0
- package/dist/components/st-drawer/st-drawer-group-content.d.ts +11 -0
- package/dist/components/st-drawer/st-drawer-group-footer.d.ts +11 -0
- package/dist/components/st-drawer/st-drawer-group-header.d.ts +15 -0
- package/dist/components/st-drawer/st-drawer-group-overlay.d.ts +9 -0
- package/dist/components/st-drawer/st-drawer-group-title.d.ts +11 -0
- package/dist/components/st-drawer/st-drawer.d.ts +8 -28
- package/dist/components/st-drawer/types.d.ts +180 -96
- package/dist/components/st-image/index.d.ts +2 -66
- package/dist/components/st-image/st-image.d.ts +2 -18
- package/dist/components/st-image/types.d.ts +4 -40
- package/dist/components/st-select/index.d.ts +3 -3
- package/dist/components/st-select/st-select.d.ts +2 -2
- package/dist/components/st-tabs/index.d.ts +3 -3
- package/dist/components/st-tabs/st-tabs.d.ts +1 -1
- package/dist/components/st-tooltip/index.d.ts +6 -6
- package/dist/components/st-tooltip/st-tooltip.d.ts +2 -2
- package/dist/context-B_FwxbY6.js +4 -0
- package/dist/global.d.ts +25 -10
- package/dist/index.d.ts +173 -140
- package/dist/straw-ui.js +3951 -5573
- package/dist/utils/cva/index.d.ts +1 -1
- package/dist/utils/directive/index.d.ts +3 -3
- package/dist/utils/z-index.d.ts +40 -0
- package/package.json +1 -1
- package/dist/components/st-dialog/st-dialog-body.d.ts +0 -14
- package/dist/components/st-dialog/st-dialog-close.d.ts +0 -4
- package/dist/components/st-dialog/st-dialog-container.d.ts +0 -34
- package/dist/components/st-dialog/st-dialog-content.d.ts +0 -20
- package/dist/components/st-dialog/st-dialog-footer.d.ts +0 -14
- package/dist/components/st-dialog/st-dialog-fullscreen.d.ts +0 -4
- package/dist/components/st-dialog/st-dialog-header.d.ts +0 -14
- package/dist/components/st-dialog/st-dialog-overlay.d.ts +0 -4
- package/dist/components/st-dialog/st-dialog-title.d.ts +0 -16
- package/dist/components/st-image/st-image-preview.d.ts +0 -16
package/README.md
CHANGED
|
@@ -23,7 +23,6 @@ npm install straw-ui-vue
|
|
|
23
23
|
```ts
|
|
24
24
|
import { createApp } from 'vue';
|
|
25
25
|
import StrawUI from 'straw-ui-vue';
|
|
26
|
-
import 'straw-ui-vue/style.css';
|
|
27
26
|
|
|
28
27
|
const app = createApp(App);
|
|
29
28
|
app.use(StrawUI);
|
|
@@ -38,16 +37,14 @@ import 'straw-ui-vue/style.css';
|
|
|
38
37
|
</script>
|
|
39
38
|
|
|
40
39
|
<template>
|
|
41
|
-
|
|
42
|
-
|
|
40
|
+
<StButton>Click me</StButton>
|
|
41
|
+
<StInput v-model="value" placeholder="Type something" />
|
|
43
42
|
</template>
|
|
44
43
|
```
|
|
45
44
|
|
|
46
45
|
## UnoCSS 集成
|
|
47
46
|
|
|
48
|
-
Straw UI 基于 UnoCSS
|
|
49
|
-
|
|
50
|
-
### 方案一:使用预设(推荐)
|
|
47
|
+
Straw UI 基于 UnoCSS 构建:
|
|
51
48
|
|
|
52
49
|
```ts
|
|
53
50
|
// uno.config.ts
|
|
@@ -55,32 +52,17 @@ import { defineConfig, presetWind4, presetIcons } from 'unocss';
|
|
|
55
52
|
import { presetStrawUI } from 'straw-ui-vue/unocss';
|
|
56
53
|
|
|
57
54
|
export default defineConfig({
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
55
|
+
presets: [
|
|
56
|
+
presetWind4(),
|
|
57
|
+
presetIcons(),
|
|
58
|
+
presetStrawUI(), // Straw UI 预设
|
|
59
|
+
],
|
|
63
60
|
});
|
|
64
61
|
```
|
|
65
62
|
|
|
66
|
-
### 方案二:使用 safelist
|
|
67
|
-
|
|
68
63
|
```ts
|
|
69
|
-
//
|
|
70
|
-
import
|
|
71
|
-
import { getStrawUISafelist } from 'straw-ui-vue/unocss';
|
|
72
|
-
|
|
73
|
-
export default defineConfig({
|
|
74
|
-
safelist: [...getStrawUISafelist()],
|
|
75
|
-
});
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### 方案三:仅引入样式
|
|
79
|
-
|
|
80
|
-
不使用 UnoCSS 时,直接引入预编译的样式:
|
|
81
|
-
|
|
82
|
-
```ts
|
|
83
|
-
import 'straw-ui-vue/style.css';
|
|
64
|
+
// main.ts
|
|
65
|
+
import 'straw-ui-vue/dist/variables.css'; // 主题预设变量,或使用自己的变量文件
|
|
84
66
|
```
|
|
85
67
|
|
|
86
68
|
详细配置请参阅 [UnoCSS 集成文档](./docs/unocss.md)。
|
|
@@ -89,49 +71,51 @@ import 'straw-ui-vue/style.css';
|
|
|
89
71
|
|
|
90
72
|
Straw UI 提供完整的 TypeScript 类型支持。
|
|
91
73
|
|
|
92
|
-
### 全局组件类型
|
|
93
|
-
|
|
94
|
-
```json
|
|
95
|
-
// tsconfig.json
|
|
96
|
-
{
|
|
97
|
-
"compilerOptions": {
|
|
98
|
-
"types": ["straw-ui-vue/global-components"]
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
详细配置请参阅 [TypeScript 配置指南](./docs/typescript.md)。
|
|
104
|
-
|
|
105
74
|
## 组件列表
|
|
106
75
|
|
|
107
|
-
| 组件
|
|
108
|
-
|
|
109
|
-
| `StButton`
|
|
110
|
-
| `
|
|
111
|
-
| `
|
|
112
|
-
| `StCheckboxGroup`
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `StDialog`
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
| `
|
|
124
|
-
| `
|
|
125
|
-
| `
|
|
76
|
+
| 组件 | 说明 |
|
|
77
|
+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
78
|
+
| `StButton` | 按钮组件 |
|
|
79
|
+
| `StCard` | 卡片组件(含 StCardGroup、StCardGroupHeader、StCardGroupTitle、StCardGroupContent、StCardGroupFooter、StCardGroupAction、StCardGroupDescription 子组件) |
|
|
80
|
+
| `StCascade` / `StCascadePanel` | 级联选择组件 |
|
|
81
|
+
| `StCheckbox` / `StCheckboxGroup` | 复选框 / 复选框组组件 |
|
|
82
|
+
| `StColorPicker` / `StColorPickerPanel` | 颜色选择器组件 |
|
|
83
|
+
| `StDatePicker` / `StDatePickerPanel` | 日期选择器组件 |
|
|
84
|
+
| `StDateTimePicker` / `StDateTimePickerPanel` | 日期时间选择器组件 |
|
|
85
|
+
| `StDialog` | 对话框组件(含 StDialogGroup、StDialogGroupHeader、StDialogGroupTitle、StDialogGroupBody、StDialogGroupContent、StDialogGroupFooter、StDialogGroupAction、StDialogGroupOverlay、StDialogGroupDraggable 子组件) |
|
|
86
|
+
| `StDivider` | 分割线组件 |
|
|
87
|
+
| `StDrawer` | 抽屉组件(含 StDrawerGroup、StDrawerGroupHeader、StDrawerGroupTitle、StDrawerGroupBody、StDrawerGroupContent、StDrawerGroupFooter、StDrawerGroupAction、StDrawerGroupOverlay 子组件) |
|
|
88
|
+
| `StEmpty` | 空状态组件 |
|
|
89
|
+
| `StFormControl` / `StFormDescription` / `StFormField` / `StFormItem` / `StFormLabel` / `StFormMessage` | 表单字段系列组件 |
|
|
90
|
+
| `StImage` | 图片组件 |
|
|
91
|
+
| `StInput` / `StInputGroup` / `StInputGroupAddon` / `StInputGroupButton` / `StInputGroupInput` / `StInputGroupText` / `StInputGroupTextarea` / `StInputNumber` / `StTextarea` | 输入框系列组件 |
|
|
92
|
+
| `StLabel` | 标签组件 |
|
|
93
|
+
| `StMenu`(含 StMenuContainer、StMenuContent、StMenuDivider、StMenuGroup、StMenuItem、StMenuNode、StMenuTrigger) | 菜单组件 |
|
|
94
|
+
| `StPagination` | 分页组件 |
|
|
95
|
+
| `StPopover`(含 StPopoverArrow、StPopoverContainer、StPopoverContent、StPopoverTrigger) | 弹出卡片组件 |
|
|
96
|
+
| `StProgress` | 进度条组件 |
|
|
97
|
+
| `StRadio` / `StRadioGroup` | 单选框 / 单选框组组件 |
|
|
98
|
+
| `StScrollbar` | 滚动条组件 |
|
|
99
|
+
| `StSegmented` | 分段控制器组件 |
|
|
100
|
+
| `StSelect`(含 StSelectContainer、StSelectContent、StSelectEmpty、StSelectGroup、StSelectItem、StSelectTrigger) | 下拉选择器组件 |
|
|
101
|
+
| `StSidebar` / `StSidebarItem` | 侧边栏 / 侧边栏项组件 |
|
|
102
|
+
| `StSkeleton` / `StSkeletonItem` | 骨架屏组件 |
|
|
103
|
+
| `StSlider` | 滑块组件 |
|
|
104
|
+
| `StSplitter` / `StSplitterPanel` | 分割面板组件 |
|
|
105
|
+
| `StSwitch` | 开关组件 |
|
|
106
|
+
| `StTabs` / `StTabsPane` | 标签页组件 |
|
|
107
|
+
| `StTag` | 标签组件 |
|
|
108
|
+
| `StTimePicker` / `StTimePickerPanel` | 时间选择器组件 |
|
|
109
|
+
| `StToggle` | 切换按钮组件 |
|
|
110
|
+
| `StTooltip`(含 StTooltipContainer、StTooltipContent、StTooltipTrigger) | 工具提示组件 |
|
|
111
|
+
| `StTree` / `StTreeNode` | 树形组件 |
|
|
126
112
|
|
|
127
113
|
## 自定义指令
|
|
128
114
|
|
|
129
|
-
| 指令
|
|
130
|
-
|
|
115
|
+
| 指令 | 说明 |
|
|
116
|
+
| ---------------- | ---------------- |
|
|
131
117
|
| `v-intersection` | 元素可视区域监听 |
|
|
132
|
-
| `v-
|
|
133
|
-
| `v-move` | 元素拖拽移动 |
|
|
134
|
-
| `v-resize` | 元素尺寸变化监听 |
|
|
118
|
+
| `v-resize` | 元素尺寸变化监听 |
|
|
135
119
|
|
|
136
120
|
## 主题定制
|
|
137
121
|
|
|
@@ -139,67 +123,25 @@ Straw UI 使用 CSS 变量定义主题,你可以通过覆盖变量来自定义
|
|
|
139
123
|
|
|
140
124
|
```css
|
|
141
125
|
:root {
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
126
|
+
--primary: #3b82f6;
|
|
127
|
+
--primary-foreground: #ffffff;
|
|
128
|
+
--radius: 0.5rem;
|
|
129
|
+
/* 更多变量... */
|
|
146
130
|
}
|
|
147
131
|
|
|
148
132
|
[data-theme='dark'] {
|
|
149
|
-
|
|
150
|
-
|
|
133
|
+
--primary: #3b82f6;
|
|
134
|
+
/* 暗色主题变量... */
|
|
151
135
|
}
|
|
152
136
|
```
|
|
153
137
|
|
|
154
138
|
完整变量列表请参阅 [UnoCSS 集成文档](./docs/unocss.md#主题变量)。
|
|
155
139
|
|
|
156
|
-
## 开发
|
|
157
|
-
|
|
158
|
-
### 环境要求
|
|
159
|
-
|
|
160
|
-
- Node.js: `^20.19.0 || >=22.12.0`
|
|
161
|
-
|
|
162
|
-
### 安装依赖
|
|
163
|
-
|
|
164
|
-
```sh
|
|
165
|
-
npm install
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### 开发模式
|
|
169
|
-
|
|
170
|
-
```sh
|
|
171
|
-
npm run dev
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### 构建库
|
|
175
|
-
|
|
176
|
-
```sh
|
|
177
|
-
npm run build:lib
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
### 类型检查
|
|
181
|
-
|
|
182
|
-
```sh
|
|
183
|
-
npm run type-check
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
### 文档开发
|
|
187
|
-
|
|
188
|
-
```sh
|
|
189
|
-
npm run docs:dev
|
|
190
|
-
```
|
|
191
|
-
|
|
192
140
|
## 文档
|
|
193
141
|
|
|
194
142
|
- [UnoCSS 集成](./docs/unocss.md)
|
|
195
143
|
- [TypeScript 配置](./docs/typescript.md)
|
|
196
144
|
|
|
197
|
-
## 推荐 IDE 设置
|
|
198
|
-
|
|
199
|
-
- [VS Code](https://code.visualstudio.com/)
|
|
200
|
-
- [Vue - Official (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.volar)(禁用 Vetur)
|
|
201
|
-
- [UnoCSS](https://marketplace.visualstudio.com/items?itemName=antfu.unocss)
|
|
202
|
-
|
|
203
145
|
## License
|
|
204
146
|
|
|
205
|
-
MIT
|
|
147
|
+
MIT
|