svelte-mobile-ui 1.0.0 → 1.2.0

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.
Files changed (3) hide show
  1. package/README.md +123 -121
  2. package/README.zh-CN.md +173 -0
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -1,38 +1,40 @@
1
1
  # svelte-mobile-ui
2
2
 
3
- 基于 Svelte 5 的移动端 UI 组件库,提供 80+ 高质量组件。
3
+ A mobile UI component library built on **Svelte 5**, providing 80+ high-quality components.
4
4
 
5
- ## 特性
5
+ [中文文档](./README.zh-CN.md)
6
6
 
7
- - 🎯 **80+ 组件** — 覆盖移动端开发常用场景
8
- - ⚡ **Svelte 5** — 基于 Svelte 5 Runes 模式,性能优异
9
- - 📦 **按需引入** — 支持全量引入和按需引入
10
- - 🌐 **CDN 支持** — 提供 IIFE 格式,可直接通过 CDN 使用
11
- - 🎨 **主题定制** — 基于 CSS 变量,轻松定制主题
12
- - 📱 **移动端优先** — 专为移动端设计,触控友好
7
+ ## Features
13
8
 
14
- ## 安装
9
+ - **80+ components** covering common mobile development scenarios
10
+ - **Svelte 5** — built on Svelte 5 Runes mode for excellent performance
11
+ - **On-demand import** — supports both full and tree-shakable imports
12
+ - **CDN support** — IIFE format available for direct CDN usage
13
+ - **Theme customization** — CSS variable-based theming
14
+ - **Mobile-first** — designed for mobile, touch-friendly
15
+
16
+ ## Installation
15
17
 
16
18
  ```bash
17
19
  npm install svelte-mobile-ui
18
20
  ```
19
21
 
20
- ## 快速开始
22
+ ## Quick Start
21
23
 
22
- ### ES Module 引入
24
+ ### ES Module
23
25
 
24
26
  ```ts
25
27
  import { Button, Cell, Icon } from 'svelte-mobile-ui'
26
28
  import 'svelte-mobile-ui/dist/styles.css'
27
29
  ```
28
30
 
29
- ### 按需引入
31
+ ### On-Demand Import
30
32
 
31
33
  ```ts
32
34
  import { Button } from 'svelte-mobile-ui/components/Button'
33
35
  ```
34
36
 
35
- ### CDN 引入
37
+ ### CDN
36
38
 
37
39
  ```html
38
40
  <link rel="stylesheet" href="https://unpkg.com/svelte-mobile-ui/dist/styles.css" />
@@ -42,104 +44,104 @@ import { Button } from 'svelte-mobile-ui/components/Button'
42
44
  </script>
43
45
  ```
44
46
 
45
- ## 组件列表
46
-
47
- ### 基础组件
48
- - `Button` — 按钮
49
- - `Cell` / `CellGroup` — 单元格
50
- - `Icon` — 图标
51
- - `ImageComp` — 图片
52
- - `Popup` — 弹出层
53
- - `Overlay` — 遮罩层
54
- - `Toast` — 轻提示
55
- - `ConfigProvider` — 全局配置
56
-
57
- ### 表单组件
58
- - `Calendar` — 日历
59
- - `Cascader` — 级联选择
60
- - `Checkbox` / `CheckboxGroup` — 复选框
61
- - `DatePicker` — 日期选择
62
- - `Field` — 输入框
63
- - `Form` — 表单
64
- - `NumberKeyboard` — 数字键盘
65
- - `PasswordInput` — 密码输入框
66
- - `Picker` / `PickerGroup` — 选择器
67
- - `Radio` / `RadioGroup` — 单选
68
- - `Rate` — 评分
69
- - `Search` — 搜索
70
- - `Slider` — 滑块
71
- - `Stepper` — 步进器
72
- - `Switch` — 开关
73
- - `TimePicker` — 时间选择
74
- - `Uploader` — 文件上传
75
-
76
- ### 反馈组件
77
- - `ActionSheet` — 动作面板
78
- - `Dialog` — 弹出框
79
- - `Loading` — 加载
80
- - `Notify` — 消息提示
81
- - `Popover` — 气泡弹出框
82
- - `PullRefresh` — 下拉刷新
83
- - `ShareSheet` — 分享面板
84
- - `SwipeCell` — 滑动单元格
85
- - `FloatingPanel` — 浮动面板
86
- - `FloatingBubble` — 浮动气泡
87
-
88
- ### 展示组件
89
- - `Badge` — 徽标
90
- - `Circle` — 环形进度条
91
- - `Collapse` / `CollapseItem` — 折叠面板
92
- - `CountDown` — 倒计时
93
- - `Divider` — 分割线
94
- - `Empty` — 空状态
95
- - `Highlight` — 高亮文本
96
- - `ImagePreview` — 图片预览
97
- - `NoticeBar` — 通知栏
98
- - `Progress` — 进度条
99
- - `Skeleton` — 骨架屏
100
- - `Steps` / `Step` — 步骤条
101
- - `Swipe` / `SwipeItem` — 轮播
102
- - `Tag` — 标签
103
- - `TextEllipsis` — 文本省略
104
- - `Watermark` — 水印
105
- - `Barrage` — 弹幕
106
- - `RollingText` — 翻滚文本
107
- - `List` — 列表
108
-
109
- ### 导航组件
110
- - `ActionBar` — 动作栏
111
- - `BackTop` — 回到顶部
112
- - `Grid` / `GridItem` — 宫格
113
- - `IndexBar` / `IndexAnchor` — 索引栏
114
- - `NavBar` — 导航栏
115
- - `Pagination` — 分页
116
- - `Sidebar` / `SidebarItem` — 侧边导航
117
- - `Sticky` — 粘性布局
118
- - `Tabs` / `Tab` — 标签页
119
- - `Tabbar` / `TabbarItem` — 标签栏
120
- - `TreeSelect` — 分类选择
121
-
122
- ### 布局组件
123
- - `Col` —
124
- - `Row` —
125
- - `Space` — 间距
126
-
127
- ### 业务组件
128
- - `AddressEdit` — 地址编辑
129
- - `AddressList` — 地址列表
130
- - `Area` — 省市区选择
131
- - `Card` — 商品卡片
132
- - `ContactCard` — 联系人卡片
133
- - `ContactEdit` — 联系人编辑
134
- - `ContactList` — 联系人列表
135
- - `Coupon` / `CouponCell` / `CouponList` — 优惠券
136
- - `Signature` — 签名
137
- - `SubmitBar` — 提交订单栏
138
- - `DropdownMenu` / `DropdownItem` — 下拉菜单
139
-
140
- ## 主题定制
141
-
142
- 通过 CSS 变量定制主题:
47
+ ## Component List
48
+
49
+ ### Basic Components
50
+ - `Button` — Button
51
+ - `Cell` / `CellGroup` — Cell
52
+ - `Icon` — Icon
53
+ - `ImageComp` — Image
54
+ - `Popup` — Popup
55
+ - `Overlay` — Overlay
56
+ - `Toast` — Toast
57
+ - `ConfigProvider` — Global Configuration
58
+
59
+ ### Form Components
60
+ - `Calendar` — Calendar
61
+ - `Cascader` — Cascader
62
+ - `Checkbox` / `CheckboxGroup` — Checkbox
63
+ - `DatePicker` — Date Picker
64
+ - `Field` — Input Field
65
+ - `Form` — Form
66
+ - `NumberKeyboard` — Number Keyboard
67
+ - `PasswordInput` — Password Input
68
+ - `Picker` / `PickerGroup` — Picker
69
+ - `Radio` / `RadioGroup` — Radio
70
+ - `Rate` — Rate
71
+ - `Search` — Search
72
+ - `Slider` — Slider
73
+ - `Stepper` — Stepper
74
+ - `Switch` — Switch
75
+ - `TimePicker` — Time Picker
76
+ - `Uploader` — File Upload
77
+
78
+ ### Feedback Components
79
+ - `ActionSheet` — Action Sheet
80
+ - `Dialog` — Dialog
81
+ - `Loading` — Loading
82
+ - `Notify` — Notification
83
+ - `Popover` — Popover
84
+ - `PullRefresh` — Pull to Refresh
85
+ - `ShareSheet` — Share Sheet
86
+ - `SwipeCell` — Swipe Cell
87
+ - `FloatingPanel` — Floating Panel
88
+ - `FloatingBubble` — Floating Bubble
89
+
90
+ ### Display Components
91
+ - `Badge` — Badge
92
+ - `Circle` — Circle Progress
93
+ - `Collapse` / `CollapseItem` — Collapse
94
+ - `CountDown` — Countdown
95
+ - `Divider` — Divider
96
+ - `Empty` — Empty State
97
+ - `Highlight` — Text Highlight
98
+ - `ImagePreview` — Image Preview
99
+ - `NoticeBar` — Notice Bar
100
+ - `Progress` — Progress
101
+ - `Skeleton` — Skeleton
102
+ - `Steps` / `Step` — Steps
103
+ - `Swipe` / `SwipeItem` — Swipe
104
+ - `Tag` — Tag
105
+ - `TextEllipsis` — Text Ellipsis
106
+ - `Watermark` — Watermark
107
+ - `Barrage` — Barrage
108
+ - `RollingText` — Rolling Text
109
+ - `List` — List
110
+
111
+ ### Navigation Components
112
+ - `ActionBar` — Action Bar
113
+ - `BackTop` — Back to Top
114
+ - `Grid` / `GridItem` — Grid
115
+ - `IndexBar` / `IndexAnchor` — Index Bar
116
+ - `NavBar` — Navigation Bar
117
+ - `Pagination` — Pagination
118
+ - `Sidebar` / `SidebarItem` — Sidebar
119
+ - `Sticky` — Sticky
120
+ - `Tabs` / `Tab` — Tabs
121
+ - `Tabbar` / `TabbarItem` — Tab Bar
122
+ - `TreeSelect` — Tree Select
123
+
124
+ ### Layout Components
125
+ - `Col` — Column
126
+ - `Row` — Row
127
+ - `Space` — Space
128
+
129
+ ### Business Components
130
+ - `AddressEdit` — Address Edit
131
+ - `AddressList` — Address List
132
+ - `Area` — Area Selector
133
+ - `Card` — Product Card
134
+ - `ContactCard` — Contact Card
135
+ - `ContactEdit` — Contact Edit
136
+ - `ContactList` — Contact List
137
+ - `Coupon` / `CouponCell` / `CouponList` — Coupon
138
+ - `Signature` — Signature
139
+ - `SubmitBar` — Submit Bar
140
+ - `DropdownMenu` / `DropdownItem` — Dropdown Menu
141
+
142
+ ## Theme Customization
143
+
144
+ Customize the theme via CSS variables:
143
145
 
144
146
  ```css
145
147
  :root {
@@ -150,23 +152,23 @@ import { Button } from 'svelte-mobile-ui/components/Button'
150
152
  }
151
153
  ```
152
154
 
153
- 或使用 `ConfigProvider` 组件:
155
+ Or use the `ConfigProvider` component:
154
156
 
155
157
  ```svelte
156
158
  <ConfigProvider theme={{ primaryColor: '#1989fa' }}>
157
- <Button type="primary">主题按钮</Button>
159
+ <Button type="primary">Themed Button</Button>
158
160
  </ConfigProvider>
159
161
  ```
160
162
 
161
- ## 兼容性
163
+ ## Compatibility
162
164
 
163
- | 格式 | 文件 | 用途 |
164
- |---|---|---|
165
- | ESM | `dist/svelte-mobile-ui.mjs` | `import` 语法 |
166
- | CJS | `dist/svelte-mobile-ui.cjs` | `require()` 语法 |
167
- | IIFE | `dist/svelte-mobile-ui.iife.js` | CDN / `<script>` 标签 |
168
- | CSS | `dist/styles.css` | 全局样式 |
169
- | Svelte 源码 | `index.ts` | Svelte 项目直接引用 |
165
+ | Format | File | Usage |
166
+ |--------|------|-------|
167
+ | ESM | `dist/svelte-mobile-ui.mjs` | `import` syntax |
168
+ | CJS | `dist/svelte-mobile-ui.cjs` | `require()` syntax |
169
+ | IIFE | `dist/svelte-mobile-ui.iife.js` | CDN / `<script>` tag |
170
+ | CSS | `dist/styles.css` | Global styles |
171
+ | Svelte Source | `index.ts` | Direct Svelte project import |
170
172
 
171
173
  ## License
172
174
 
@@ -0,0 +1,173 @@
1
+ # svelte-mobile-ui
2
+
3
+ 基于 Svelte 5 的移动端 UI 组件库,提供 80+ 高质量组件。
4
+
5
+ ## 特性
6
+
7
+ - 🎯 **80+ 组件** — 覆盖移动端开发常用场景
8
+ - ⚡ **Svelte 5** — 基于 Svelte 5 Runes 模式,性能优异
9
+ - 📦 **按需引入** — 支持全量引入和按需引入
10
+ - 🌐 **CDN 支持** — 提供 IIFE 格式,可直接通过 CDN 使用
11
+ - 🎨 **主题定制** — 基于 CSS 变量,轻松定制主题
12
+ - 📱 **移动端优先** — 专为移动端设计,触控友好
13
+
14
+ ## 安装
15
+
16
+ ```bash
17
+ npm install svelte-mobile-ui
18
+ ```
19
+
20
+ ## 快速开始
21
+
22
+ ### ES Module 引入
23
+
24
+ ```ts
25
+ import { Button, Cell, Icon } from 'svelte-mobile-ui'
26
+ import 'svelte-mobile-ui/dist/styles.css'
27
+ ```
28
+
29
+ ### 按需引入
30
+
31
+ ```ts
32
+ import { Button } from 'svelte-mobile-ui/components/Button'
33
+ ```
34
+
35
+ ### CDN 引入
36
+
37
+ ```html
38
+ <link rel="stylesheet" href="https://unpkg.com/svelte-mobile-ui/dist/styles.css" />
39
+ <script src="https://unpkg.com/svelte-mobile-ui/dist/svelte-mobile-ui.iife.js"></script>
40
+ <script>
41
+ const { Button, Cell } = SvelteMobileUI
42
+ </script>
43
+ ```
44
+
45
+ ## 组件列表
46
+
47
+ ### 基础组件
48
+ - `Button` — 按钮
49
+ - `Cell` / `CellGroup` — 单元格
50
+ - `Icon` — 图标
51
+ - `ImageComp` — 图片
52
+ - `Popup` — 弹出层
53
+ - `Overlay` — 遮罩层
54
+ - `Toast` — 轻提示
55
+ - `ConfigProvider` — 全局配置
56
+
57
+ ### 表单组件
58
+ - `Calendar` — 日历
59
+ - `Cascader` — 级联选择
60
+ - `Checkbox` / `CheckboxGroup` — 复选框
61
+ - `DatePicker` — 日期选择
62
+ - `Field` — 输入框
63
+ - `Form` — 表单
64
+ - `NumberKeyboard` — 数字键盘
65
+ - `PasswordInput` — 密码输入框
66
+ - `Picker` / `PickerGroup` — 选择器
67
+ - `Radio` / `RadioGroup` — 单选
68
+ - `Rate` — 评分
69
+ - `Search` — 搜索
70
+ - `Slider` — 滑块
71
+ - `Stepper` — 步进器
72
+ - `Switch` — 开关
73
+ - `TimePicker` — 时间选择
74
+ - `Uploader` — 文件上传
75
+
76
+ ### 反馈组件
77
+ - `ActionSheet` — 动作面板
78
+ - `Dialog` — 弹出框
79
+ - `Loading` — 加载
80
+ - `Notify` — 消息提示
81
+ - `Popover` — 气泡弹出框
82
+ - `PullRefresh` — 下拉刷新
83
+ - `ShareSheet` — 分享面板
84
+ - `SwipeCell` — 滑动单元格
85
+ - `FloatingPanel` — 浮动面板
86
+ - `FloatingBubble` — 浮动气泡
87
+
88
+ ### 展示组件
89
+ - `Badge` — 徽标
90
+ - `Circle` — 环形进度条
91
+ - `Collapse` / `CollapseItem` — 折叠面板
92
+ - `CountDown` — 倒计时
93
+ - `Divider` — 分割线
94
+ - `Empty` — 空状态
95
+ - `Highlight` — 高亮文本
96
+ - `ImagePreview` — 图片预览
97
+ - `NoticeBar` — 通知栏
98
+ - `Progress` — 进度条
99
+ - `Skeleton` — 骨架屏
100
+ - `Steps` / `Step` — 步骤条
101
+ - `Swipe` / `SwipeItem` — 轮播
102
+ - `Tag` — 标签
103
+ - `TextEllipsis` — 文本省略
104
+ - `Watermark` — 水印
105
+ - `Barrage` — 弹幕
106
+ - `RollingText` — 翻滚文本
107
+ - `List` — 列表
108
+
109
+ ### 导航组件
110
+ - `ActionBar` — 动作栏
111
+ - `BackTop` — 回到顶部
112
+ - `Grid` / `GridItem` — 宫格
113
+ - `IndexBar` / `IndexAnchor` — 索引栏
114
+ - `NavBar` — 导航栏
115
+ - `Pagination` — 分页
116
+ - `Sidebar` / `SidebarItem` — 侧边导航
117
+ - `Sticky` — 粘性布局
118
+ - `Tabs` / `Tab` — 标签页
119
+ - `Tabbar` / `TabbarItem` — 标签栏
120
+ - `TreeSelect` — 分类选择
121
+
122
+ ### 布局组件
123
+ - `Col` — 列
124
+ - `Row` — 行
125
+ - `Space` — 间距
126
+
127
+ ### 业务组件
128
+ - `AddressEdit` — 地址编辑
129
+ - `AddressList` — 地址列表
130
+ - `Area` — 省市区选择
131
+ - `Card` — 商品卡片
132
+ - `ContactCard` — 联系人卡片
133
+ - `ContactEdit` — 联系人编辑
134
+ - `ContactList` — 联系人列表
135
+ - `Coupon` / `CouponCell` / `CouponList` — 优惠券
136
+ - `Signature` — 签名
137
+ - `SubmitBar` — 提交订单栏
138
+ - `DropdownMenu` / `DropdownItem` — 下拉菜单
139
+
140
+ ## 主题定制
141
+
142
+ 通过 CSS 变量定制主题:
143
+
144
+ ```css
145
+ :root {
146
+ --smu-primary-color: #1989fa;
147
+ --smu-success-color: #07c160;
148
+ --smu-warning-color: #ff976a;
149
+ --smu-danger-color: #ee0a24;
150
+ }
151
+ ```
152
+
153
+ 或使用 `ConfigProvider` 组件:
154
+
155
+ ```svelte
156
+ <ConfigProvider theme={{ primaryColor: '#1989fa' }}>
157
+ <Button type="primary">主题按钮</Button>
158
+ </ConfigProvider>
159
+ ```
160
+
161
+ ## 兼容性
162
+
163
+ | 格式 | 文件 | 用途 |
164
+ |---|---|---|
165
+ | ESM | `dist/svelte-mobile-ui.mjs` | `import` 语法 |
166
+ | CJS | `dist/svelte-mobile-ui.cjs` | `require()` 语法 |
167
+ | IIFE | `dist/svelte-mobile-ui.iife.js` | CDN / `<script>` 标签 |
168
+ | CSS | `dist/styles.css` | 全局样式 |
169
+ | Svelte 源码 | `index.ts` | Svelte 项目直接引用 |
170
+
171
+ ## License
172
+
173
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "svelte-mobile-ui",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "type": "module",
5
5
  "description": "基于 Svelte 5 的移动端 UI 组件库,提供 70+ 组件",
6
6
  "keywords": [
@@ -42,7 +42,7 @@
42
42
  "utils/",
43
43
  "index.ts",
44
44
  "LICENSE",
45
- "README.md"
45
+ "README.md","README.zh-CN.md"
46
46
  ],
47
47
  "sideEffects": [
48
48
  "**/*.css",
@@ -60,4 +60,4 @@
60
60
  "sass": "^1.99.0",
61
61
  "svelte": "^5.55.1"
62
62
  }
63
- }
63
+ }