solely 0.0.30 → 0.1.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.
- package/README.md +817 -507
- package/dist/compiler/index.d.ts +2 -0
- package/dist/compiler/ir/buildIR.d.ts +12 -0
- package/dist/compiler/ir/index.d.ts +1 -0
- package/dist/compiler/parser/index.d.ts +1 -0
- package/dist/compiler/parser/parser.d.ts +5 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +1756 -0
- package/dist/index.umd.cjs +47 -0
- package/dist/plugin.d.ts +1 -0
- package/dist/plugins/html-parse-precompile.d.ts +1 -0
- package/dist/plugins/html-precompile.d.ts +1 -0
- package/dist/plugins/index.d.ts +1 -0
- package/dist/runtime/component/base-element.d.ts +24 -0
- package/dist/{base → runtime/component}/decorators.d.ts +6 -4
- package/dist/runtime/component/index.d.ts +2 -0
- package/dist/runtime/index.d.ts +4 -0
- package/dist/runtime/reactivity/index.d.ts +2 -0
- package/dist/runtime/reactivity/observe.d.ts +47 -0
- package/dist/{utils/observe.d.ts → runtime/reactivity/types.d.ts} +0 -8
- package/dist/runtime/renderer/index.d.ts +1 -0
- package/dist/runtime/renderer/renderIR.d.ts +25 -0
- package/dist/runtime/router/core.d.ts +42 -0
- package/dist/runtime/router/index.d.ts +6 -0
- package/dist/runtime/router/router-link.d.ts +17 -0
- package/dist/runtime/router/router-view.d.ts +25 -0
- package/dist/runtime/router/types.d.ts +65 -0
- package/dist/shared/event-listeners.d.ts +2 -0
- package/dist/shared/gen-function.d.ts +3 -0
- package/dist/shared/index.d.ts +6 -0
- package/dist/shared/templateError.d.ts +9 -0
- package/dist/types/ast.d.ts +38 -0
- package/dist/types/component.d.ts +66 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/ir.d.ts +67 -0
- package/dist/types/lifecycle.d.ts +4 -0
- package/dist/types/loop.d.ts +4 -0
- package/package.json +24 -6
- package/dist/base/base-element.d.ts +0 -56
- package/dist/base/index.d.ts +0 -5
- package/dist/base/router-view.d.ts +0 -43
- package/dist/solely.d.ts +0 -2
- package/dist/solely.js +0 -941
- package/dist/solely.umd.cjs +0 -3
- package/dist/utils/ast-processor.d.ts +0 -2
- package/dist/utils/async-queue.d.ts +0 -1
- package/dist/utils/event-listeners.d.ts +0 -2
- package/dist/utils/html-parse.d.ts +0 -45
- package/dist/utils/index.d.ts +0 -8
- /package/dist/{utils → shared}/functions.d.ts +0 -0
- /package/dist/{utils → shared}/is-object.d.ts +0 -0
- /package/dist/{utils → shared}/url.d.ts +0 -0
package/README.md
CHANGED
|
@@ -1,507 +1,817 @@
|
|
|
1
|
-
# Solely
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
<
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
```html
|
|
139
|
-
|
|
140
|
-
<
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
<
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
<
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
```html
|
|
220
|
-
|
|
221
|
-
<
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
<
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
<
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
<
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
```
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
```
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
styles:
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
}
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
```
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
1
|
+
# Solely - 轻量级 Web 组件框架
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
**一个轻量级、现代化的 Web 组件开发框架**
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/solely)
|
|
10
|
+
[](LICENSE)
|
|
11
|
+
[](https://www.typescriptlang.org/)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
## ✨ 核心特性
|
|
16
|
+
|
|
17
|
+
- **🚀 高性能**:轻量级架构,零运行时依赖,快速渲染
|
|
18
|
+
- **🔧 类型安全**:完整的 TypeScript 支持,类型提示完善
|
|
19
|
+
- **🎨 强大模板**:基于 AST 的模板编译,支持条件渲染和列表渲染
|
|
20
|
+
- **⚡ 响应式系统**:高效的响应式数据绑定,自动追踪依赖
|
|
21
|
+
- **🧩 Web 组件**:原生 Web 组件支持,可自定义元素
|
|
22
|
+
- **📦 插件系统**:灵活的插件扩展机制
|
|
23
|
+
- **🧪 测试完善**:完整的单元测试覆盖
|
|
24
|
+
- **🗺️ 路由支持**:内置路由系统,支持单页应用开发
|
|
25
|
+
|
|
26
|
+
## 📦 安装
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# 使用 npm
|
|
30
|
+
npm install solely
|
|
31
|
+
|
|
32
|
+
# 使用 yarn
|
|
33
|
+
yarn add solely
|
|
34
|
+
|
|
35
|
+
# 使用 pnpm
|
|
36
|
+
pnpm add solely
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## 🎯 快速开始
|
|
40
|
+
|
|
41
|
+
### 1. 创建一个简单的组件
|
|
42
|
+
|
|
43
|
+
创建一个 TypeScript 文件:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
// counter.ts
|
|
47
|
+
import { BaseElement, CustomElement } from 'solely';
|
|
48
|
+
|
|
49
|
+
@CustomElement({
|
|
50
|
+
tagName: 'my-counter',
|
|
51
|
+
template: `
|
|
52
|
+
<div class="counter">
|
|
53
|
+
<h2>计数器: {{ $data.count }}</h2>
|
|
54
|
+
<button @click="$data.count++">增加</button>
|
|
55
|
+
</div>
|
|
56
|
+
`,
|
|
57
|
+
props: [
|
|
58
|
+
{ name: 'count', type: 'number' }
|
|
59
|
+
],
|
|
60
|
+
styles: `
|
|
61
|
+
.counter {
|
|
62
|
+
text-align: center;
|
|
63
|
+
padding: 20px;
|
|
64
|
+
}
|
|
65
|
+
button {
|
|
66
|
+
padding: 10px 20px;
|
|
67
|
+
font-size: 16px;
|
|
68
|
+
cursor: pointer;
|
|
69
|
+
}
|
|
70
|
+
`
|
|
71
|
+
})
|
|
72
|
+
class MyCounter extends BaseElement<{ count: number }> {
|
|
73
|
+
constructor() {
|
|
74
|
+
super({ count: 0 });
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 2. 在 HTML 中使用
|
|
80
|
+
|
|
81
|
+
```html
|
|
82
|
+
<!-- index.html -->
|
|
83
|
+
<!DOCTYPE html>
|
|
84
|
+
<html lang="zh-CN">
|
|
85
|
+
<head>
|
|
86
|
+
<meta charset="UTF-8">
|
|
87
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
88
|
+
<title>Solely 示例</title>
|
|
89
|
+
<script type="module" src="./counter.ts"></script>
|
|
90
|
+
</head>
|
|
91
|
+
<body>
|
|
92
|
+
<my-counter></my-counter>
|
|
93
|
+
</body>
|
|
94
|
+
</html>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## 📚 模板语法
|
|
98
|
+
|
|
99
|
+
所有模板必须是 **合法 HTML**;框架会提前编译成高效更新函数,无运行时解析开销。
|
|
100
|
+
|
|
101
|
+
### 语法对照表
|
|
102
|
+
|
|
103
|
+
| 功能 | 推荐语法 | 兼容语法 | 完整示例 |
|
|
104
|
+
|---|---|---|---|
|
|
105
|
+
| **文本插值** | `{{ 表达式 }}` | `{{ 表达式 }}` | `<span>{{ $data.msg }}</span>` |
|
|
106
|
+
| **属性绑定** | `:属性名="表达式"` | `s-属性名="表达式"` | `<img :src="$data.url" s-alt="$data.name">` |
|
|
107
|
+
| **布尔属性** | `:属性名="表达式"` | `s-属性名="表达式"` | `<button :disabled="$data.loading">提交</button>` |
|
|
108
|
+
| **双向绑定** | `s-model="字段路径"` | `s-model="字段路径"` | `<input s-model="$data.username">` |
|
|
109
|
+
| **原始事件** | `@事件名="语句"` | `on-事件名="语句"` | `<button @click="$data.count++">增加</button>` |
|
|
110
|
+
| **条件渲染** | `<If test="表达式">` | `<If condition="表达式">` | `<If test="$data.ok"><p>成功</p></If>` |
|
|
111
|
+
| **列表渲染** | `<For each="数组" item="项变量">` | `<For each="数组" item="项变量">` | `<For each="$data.list" item="it">{{ it }}</For>` |
|
|
112
|
+
| **动态类** | `:class="对象/数组/字符串"` | `s-class="对象/数组/字符串"` | `<div :class="{ active: $data.isActive }">` |
|
|
113
|
+
| **动态样式** | `:style="对象"` | `s-style="对象"` | `<div :style="{ color: $data.c }">` |
|
|
114
|
+
|
|
115
|
+
### 详细语法说明
|
|
116
|
+
|
|
117
|
+
#### 1. 文本插值
|
|
118
|
+
|
|
119
|
+
使用 `{{ 表达式 }}` 在模板中插入动态文本:
|
|
120
|
+
|
|
121
|
+
```html
|
|
122
|
+
<h1>Hello, {{ $data.name }}!</h1>
|
|
123
|
+
<p>总数: {{ $data.items.length }}</p>
|
|
124
|
+
<p>{{ $data.price * $data.quantity }}</p>
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
#### 2. 属性绑定
|
|
128
|
+
|
|
129
|
+
使用 `:属性名` 绑定动态属性(推荐):
|
|
130
|
+
|
|
131
|
+
```html
|
|
132
|
+
<img :src="$data.imageUrl" :alt="$data.imageAlt">
|
|
133
|
+
<a :href="$data.linkUrl">访问链接</a>
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
兼容语法:
|
|
137
|
+
|
|
138
|
+
```html
|
|
139
|
+
<img s-src="$data.imageUrl" s-alt="$data.imageAlt">
|
|
140
|
+
<a s-href="$data.linkUrl">访问链接</a>
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
#### 3. 布尔属性
|
|
144
|
+
|
|
145
|
+
当表达式为真值时才会输出属性:
|
|
146
|
+
|
|
147
|
+
```html
|
|
148
|
+
<button :disabled="$data.isLoading">提交</button>
|
|
149
|
+
<input :checked="$data.isAgreed">
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
兼容语法:
|
|
153
|
+
|
|
154
|
+
```html
|
|
155
|
+
<button s-disabled="$data.isLoading">提交</button>
|
|
156
|
+
<input s-checked="$data.isAgreed">
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
#### 4. 双向绑定
|
|
160
|
+
|
|
161
|
+
使用 `s-model` 实现表单双向绑定(推荐):
|
|
162
|
+
|
|
163
|
+
```html
|
|
164
|
+
<input s-model="$data.username">
|
|
165
|
+
<textarea s-model="$data.content"></textarea>
|
|
166
|
+
<select s-model="$data.selectedId">
|
|
167
|
+
<option value="1">选项1</option>
|
|
168
|
+
<option value="2">选项2</option>
|
|
169
|
+
</select>
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
兼容语法:
|
|
173
|
+
|
|
174
|
+
```html
|
|
175
|
+
<input s-model="$data.username">
|
|
176
|
+
<textarea s-model="$data.content"></textarea>
|
|
177
|
+
<select s-model="$data.selectedId">
|
|
178
|
+
<option value="1">选项1</option>
|
|
179
|
+
<option value="2">选项2</option>
|
|
180
|
+
</select>
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
#### 5. 事件处理
|
|
184
|
+
|
|
185
|
+
使用 `@事件名` 绑定事件,可直接读写 `$data`(推荐):
|
|
186
|
+
|
|
187
|
+
```html
|
|
188
|
+
<button @click="$data.count++">增加</button>
|
|
189
|
+
<button @click="$data.items.push($data.newItem); $data.newItem=''">添加</button>
|
|
190
|
+
<input @input="$data.searchText = event.target.value">
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
兼容语法:
|
|
194
|
+
|
|
195
|
+
```html
|
|
196
|
+
<button onclick="$data.count++">增加</button>
|
|
197
|
+
<button onclick="$data.items.push($data.newItem); $data.newItem=''">添加</button>
|
|
198
|
+
<input oninput="$data.searchText = event.target.value">
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
#### 6. 条件渲染
|
|
202
|
+
|
|
203
|
+
使用 `<If>`、`<ElseIf>`、`<Else>` 进行条件渲染:
|
|
204
|
+
|
|
205
|
+
```html
|
|
206
|
+
<If test="$data.isLoggedIn">
|
|
207
|
+
<p>欢迎回来,{{ $data.username }}!</p>
|
|
208
|
+
</If>
|
|
209
|
+
<ElseIf test="$data.isLoading">
|
|
210
|
+
<p>加载中...</p>
|
|
211
|
+
</ElseIf>
|
|
212
|
+
<Else>
|
|
213
|
+
<p>请登录</p>
|
|
214
|
+
</Else>
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
兼容语法:
|
|
218
|
+
|
|
219
|
+
```html
|
|
220
|
+
<If condition="$data.isLoggedIn">
|
|
221
|
+
<p>欢迎回来,{{ $data.username }}!</p>
|
|
222
|
+
</If>
|
|
223
|
+
<ElseIf condition="$data.isLoading">
|
|
224
|
+
<p>加载中...</p>
|
|
225
|
+
</ElseIf>
|
|
226
|
+
<Else>
|
|
227
|
+
<p>请登录</p>
|
|
228
|
+
</Else>
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
#### 7. 列表渲染
|
|
232
|
+
|
|
233
|
+
使用 `<For>` 渲染列表:
|
|
234
|
+
|
|
235
|
+
```html
|
|
236
|
+
<ul>
|
|
237
|
+
<For each="$data.items" item="item" index="i">
|
|
238
|
+
<li>{{ i + 1 }}. {{ item.name }}</li>
|
|
239
|
+
</For>
|
|
240
|
+
</ul>
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
兼容语法:
|
|
244
|
+
|
|
245
|
+
```html
|
|
246
|
+
<ul>
|
|
247
|
+
<For each="$data.items" item="item" index="i">
|
|
248
|
+
<li>{{ i + 1 }}. {{ item.name }}</li>
|
|
249
|
+
</For>
|
|
250
|
+
</ul>
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
#### 8. 动态类
|
|
254
|
+
|
|
255
|
+
使用 `:class` 动态控制 CSS 类(推荐):
|
|
256
|
+
|
|
257
|
+
```html
|
|
258
|
+
<div :class="{ active: $data.isActive, 'has-error': $data.hasError }">
|
|
259
|
+
内容
|
|
260
|
+
</div>
|
|
261
|
+
<!-- 也支持数组和字符串 -->
|
|
262
|
+
<div :class="[$data.class1, $data.class2]">内容</div>
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
兼容语法:
|
|
266
|
+
|
|
267
|
+
```html
|
|
268
|
+
<div s-class="{ active: $data.isActive, 'has-error': $data.hasError }">
|
|
269
|
+
内容
|
|
270
|
+
</div>
|
|
271
|
+
<!-- 也支持数组和字符串 -->
|
|
272
|
+
<div s-class="[$data.class1, $data.class2]">内容</div>
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
#### 9. 动态样式
|
|
276
|
+
|
|
277
|
+
使用 `:style` 动态设置样式(推荐):
|
|
278
|
+
|
|
279
|
+
```html
|
|
280
|
+
<div :style="{ color: $data.textColor, fontSize: $data.fontSize + 'px' }">
|
|
281
|
+
动态样式
|
|
282
|
+
</div>
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
兼容语法:
|
|
286
|
+
|
|
287
|
+
```html
|
|
288
|
+
<div s-style="{ color: $data.textColor, fontSize: $data.fontSize + 'px' }">
|
|
289
|
+
动态样式
|
|
290
|
+
</div>
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
## 🏗️ 技术架构
|
|
294
|
+
|
|
295
|
+
Solely 采用模块化设计,主要由以下部分组成:
|
|
296
|
+
|
|
297
|
+
```
|
|
298
|
+
solely/
|
|
299
|
+
├── compiler/ # 模板编译器
|
|
300
|
+
│ ├── ir/ # 中间表示层
|
|
301
|
+
│ └── parser/ # AST 解析器
|
|
302
|
+
├── runtime/ # 运行时核心
|
|
303
|
+
│ ├── component/ # 组件基类和装饰器
|
|
304
|
+
│ ├── reactivity/ # 响应式系统
|
|
305
|
+
│ ├── renderer/ # 渲染器
|
|
306
|
+
│ └── router/ # 路由系统
|
|
307
|
+
├── shared/ # 共享工具函数
|
|
308
|
+
├── types/ # TypeScript 类型定义
|
|
309
|
+
├── plugins/ # 插件系统
|
|
310
|
+
└── tests/ # 测试文件
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
### 核心模块说明
|
|
314
|
+
|
|
315
|
+
1. **编译器**:将模板转换为高效的渲染函数,支持 AST 解析和中间表示优化
|
|
316
|
+
2. **运行时**:包含组件系统、响应式系统、渲染器和路由系统
|
|
317
|
+
3. **响应式系统**:基于 Proxy 的响应式数据绑定,自动追踪依赖
|
|
318
|
+
4. **路由系统**:支持单页应用的路由管理,包括路由定义、导航和组件挂载
|
|
319
|
+
5. **插件系统**:提供扩展机制,支持自定义功能
|
|
320
|
+
|
|
321
|
+
## 🔧 API 参考
|
|
322
|
+
|
|
323
|
+
### CustomElement 装饰器
|
|
324
|
+
|
|
325
|
+
组件的注册装饰器,用于定义组件的元信息:
|
|
326
|
+
|
|
327
|
+
```typescript
|
|
328
|
+
@CustomElement({
|
|
329
|
+
tagName: 'my-component', // 必须:组件标签名
|
|
330
|
+
template: '...', // 必须:HTML 模板字符串
|
|
331
|
+
props: [...], // 可选:属性定义
|
|
332
|
+
styles: '...', // 可选:组件样式
|
|
333
|
+
shadowDOM: { use: true } // 可选:使用 Shadow DOM
|
|
334
|
+
})
|
|
335
|
+
class MyComponent extends BaseElement<MyData> {
|
|
336
|
+
// 组件逻辑
|
|
337
|
+
}
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### BaseElement
|
|
341
|
+
|
|
342
|
+
组件的基类,提供响应式属性、生命周期钩子和渲染方法。
|
|
343
|
+
|
|
344
|
+
#### 生命周期钩子
|
|
345
|
+
|
|
346
|
+
Solely 提供了完整的生命周期钩子函数,用于在组件的不同阶段执行自定义逻辑:
|
|
347
|
+
|
|
348
|
+
| 钩子函数 | 调用时机 | 说明 |
|
|
349
|
+
|---|---|---|
|
|
350
|
+
| `created()` | 组件实例创建后 | 在组件构造函数执行完成后调用,此时组件尚未挂载到 DOM |
|
|
351
|
+
| `mounted()` | 组件挂载到 DOM 后 | 组件首次渲染完成后调用,可在此进行 DOM 操作 |
|
|
352
|
+
| `beforeUpdate()` | 数据更新前 | 在组件数据更新导致重新渲染前调用 |
|
|
353
|
+
| `updated()` | 数据更新后 | 在组件数据更新导致重新渲染后调用 |
|
|
354
|
+
| `unmounted()` | 组件从 DOM 移除后 | 组件被销毁时调用,可在此清理资源 |
|
|
355
|
+
| `attributeChanged(name, oldValue, newValue)` | 属性变化时 | 当组件的观察属性发生变化时调用 |
|
|
356
|
+
| `beforeAttributesUpdate()` | 属性更新前 | 在属性更新导致重新渲染前调用 |
|
|
357
|
+
| `afterAttributesUpdate()` | 属性更新后 | 在属性更新导致重新渲染后调用 |
|
|
358
|
+
| `onInit()` | 组件初始化后 | 组件挂载完成后调用,支持异步操作 |
|
|
359
|
+
|
|
360
|
+
#### 示例代码
|
|
361
|
+
|
|
362
|
+
```typescript
|
|
363
|
+
class MyComponent extends BaseElement<MyData> {
|
|
364
|
+
constructor() {
|
|
365
|
+
super({ /* 初始数据 */ });
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
// 组件实例创建后调用
|
|
369
|
+
created() {
|
|
370
|
+
console.log('组件实例已创建');
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
// 组件挂载到 DOM 后调用
|
|
374
|
+
mounted() {
|
|
375
|
+
console.log('组件已挂载到 DOM');
|
|
376
|
+
// 可在此进行 DOM 操作
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
// 数据更新前调用
|
|
380
|
+
beforeUpdate() {
|
|
381
|
+
console.log('组件即将更新');
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
// 数据更新后调用
|
|
385
|
+
updated() {
|
|
386
|
+
console.log('组件已更新');
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
// 组件从 DOM 移除后调用
|
|
390
|
+
unmounted() {
|
|
391
|
+
console.log('组件已卸载');
|
|
392
|
+
// 可在此清理资源
|
|
393
|
+
}
|
|
394
|
+
|
|
395
|
+
// 属性变化时调用
|
|
396
|
+
attributeChanged(name, oldValue, newValue) {
|
|
397
|
+
console.log(`属性 ${name} 从 ${oldValue} 变为 ${newValue}`);
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
// 组件初始化后调用,支持异步操作
|
|
401
|
+
async onInit() {
|
|
402
|
+
console.log('组件初始化中');
|
|
403
|
+
// 可在此进行异步操作,如数据获取
|
|
404
|
+
await fetchData();
|
|
405
|
+
console.log('组件初始化完成');
|
|
406
|
+
}
|
|
407
|
+
}
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
#### 核心方法
|
|
411
|
+
|
|
412
|
+
| 方法 | 说明 | 参数 | 返回值 |
|
|
413
|
+
|---|---|---|---|
|
|
414
|
+
| `$data` | 获取/设置组件数据 | 新数据对象(设置时) | 当前数据对象 |
|
|
415
|
+
| `refresh()` | 手动触发组件刷新 | 无 | 无 |
|
|
416
|
+
| `emit(eventName, detail, options)` | 派发自定义事件 | eventName: 事件名<br>detail: 事件详情<br>options: 事件选项 | 无 |
|
|
417
|
+
|
|
418
|
+
### observe
|
|
419
|
+
|
|
420
|
+
创建响应式数据对象,用于非组件场景的响应式数据:
|
|
421
|
+
|
|
422
|
+
```typescript
|
|
423
|
+
import { observe } from 'solely';
|
|
424
|
+
|
|
425
|
+
const state = observe({
|
|
426
|
+
name: 'Solely',
|
|
427
|
+
items: [1, 2, 3]
|
|
428
|
+
}, (path, newValue, oldValue) => {
|
|
429
|
+
console.log('数据变化:', path, oldValue, '->', newValue);
|
|
430
|
+
});
|
|
431
|
+
|
|
432
|
+
state.name = 'New Name'; // 触发回调
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### 路由系统
|
|
436
|
+
|
|
437
|
+
Solely 提供了功能强大的内置路由系统,支持单页应用开发,包括路由定义、导航、参数传递、路由守卫等功能。
|
|
438
|
+
|
|
439
|
+
#### 路由配置
|
|
440
|
+
|
|
441
|
+
首先,定义路由配置:
|
|
442
|
+
|
|
443
|
+
```typescript
|
|
444
|
+
import { createRouter } from 'solely';
|
|
445
|
+
|
|
446
|
+
const routes = [
|
|
447
|
+
{ path: '/', tagName: 'home-page' },
|
|
448
|
+
{ path: '/about', tagName: 'about-page' },
|
|
449
|
+
{ path: '/users/:id', tagName: 'user-detail' },
|
|
450
|
+
{ path: '*', tagName: 'not-found' } // 404 页面
|
|
451
|
+
];
|
|
452
|
+
|
|
453
|
+
const router = createRouter({
|
|
454
|
+
routes,
|
|
455
|
+
base: '/', // 基础路径
|
|
456
|
+
mode: 'history' // 路由模式:'hash' | 'history'
|
|
457
|
+
});
|
|
458
|
+
|
|
459
|
+
// 启动路由监听
|
|
460
|
+
router.setupListeners();
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
#### 路由配置选项
|
|
464
|
+
|
|
465
|
+
| 选项 | 类型 | 说明 | 示例 |
|
|
466
|
+
|---|---|---|---|
|
|
467
|
+
| `path` | `string` | 路由路径,支持动态参数 | `'/users/:id'` |
|
|
468
|
+
| `tagName` | `string` | 组件标签名 | `'user-detail'` |
|
|
469
|
+
| `component` | `Function` | 异步组件加载函数 | `() => import('./pages/user.js')` |
|
|
470
|
+
| `name` | `string` | 路由名称 | `'user'` |
|
|
471
|
+
| `keepAlive` | `boolean` | 是否缓存组件实例 | `true` |
|
|
472
|
+
| `forceReload` | `boolean` | 是否强制重新加载 | `true` |
|
|
473
|
+
| `redirect` | `string` | 重定向路径 | `'/login'` |
|
|
474
|
+
| `props` | `Object` | 传递给组件的属性 | `{ title: '用户详情' }` |
|
|
475
|
+
| `meta` | `Object` | 路由元信息 | `{ requiresAuth: true }` |
|
|
476
|
+
| `children` | `RouteConfig[]` | 嵌套子路由 | `[{ path: 'profile', tagName: 'user-profile' }]` |
|
|
477
|
+
|
|
478
|
+
#### 路由导航
|
|
479
|
+
|
|
480
|
+
使用路由方法进行页面导航:
|
|
481
|
+
|
|
482
|
+
```typescript
|
|
483
|
+
// 基本导航
|
|
484
|
+
router.push('/about');
|
|
485
|
+
|
|
486
|
+
// 替换当前历史记录
|
|
487
|
+
router.replace('/about');
|
|
488
|
+
|
|
489
|
+
// 带查询参数
|
|
490
|
+
router.pushWithQuery('/search', { q: 'solely', page: '1' });
|
|
491
|
+
|
|
492
|
+
// 返回上一页
|
|
493
|
+
router.back();
|
|
494
|
+
|
|
495
|
+
// 解析路径为真实 URL
|
|
496
|
+
const url = router.resolve('/users/1'); // 根据模式返回 #/users/1 或 /users/1
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
#### 路由参数
|
|
500
|
+
|
|
501
|
+
获取路由参数:
|
|
502
|
+
|
|
503
|
+
```typescript
|
|
504
|
+
// 获取当前路由信息
|
|
505
|
+
const currentRoute = router.getCurrentRoute();
|
|
506
|
+
|
|
507
|
+
if (currentRoute) {
|
|
508
|
+
// 获取路径参数
|
|
509
|
+
console.log(currentRoute.params.id); // 从 /users/:id 中获取 id
|
|
510
|
+
|
|
511
|
+
// 获取查询参数
|
|
512
|
+
console.log(currentRoute.query.q); // 从 ?q=solely 中获取 q
|
|
513
|
+
|
|
514
|
+
// 获取完整路径
|
|
515
|
+
console.log(currentRoute.fullPath); // /users/123?q=solely
|
|
516
|
+
|
|
517
|
+
// 获取路由元信息
|
|
518
|
+
console.log(currentRoute.meta); // { requiresAuth: true }
|
|
519
|
+
|
|
520
|
+
// 获取匹配的路由层级
|
|
521
|
+
console.log(currentRoute.matched); // 匹配的路由数组
|
|
522
|
+
}
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
#### 路由守卫
|
|
526
|
+
|
|
527
|
+
Solely 支持全局路由守卫,用于控制导航流程:
|
|
528
|
+
|
|
529
|
+
```typescript
|
|
530
|
+
// 创建路由时配置守卫
|
|
531
|
+
const router = createRouter({
|
|
532
|
+
routes,
|
|
533
|
+
beforeEach: async (to, from) => {
|
|
534
|
+
// 验证权限
|
|
535
|
+
if (to.meta.requiresAuth && !isLoggedIn) {
|
|
536
|
+
return '/login'; // 重定向到登录页
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
// 阻止导航
|
|
540
|
+
if (to.path === '/admin' && !isAdmin) {
|
|
541
|
+
return false;
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
// 允许导航
|
|
545
|
+
return true;
|
|
546
|
+
},
|
|
547
|
+
afterEach: (to, from) => {
|
|
548
|
+
// 导航完成后执行
|
|
549
|
+
console.log('从', from.fullPath, '导航到', to.fullPath);
|
|
550
|
+
document.title = to.meta.title || 'Solely App';
|
|
551
|
+
}
|
|
552
|
+
});
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
#### 嵌套路由
|
|
556
|
+
|
|
557
|
+
Solely 支持嵌套路由,实现复杂的页面结构:
|
|
558
|
+
|
|
559
|
+
```typescript
|
|
560
|
+
const routes = [
|
|
561
|
+
{
|
|
562
|
+
path: '/user',
|
|
563
|
+
tagName: 'user-layout',
|
|
564
|
+
children: [
|
|
565
|
+
{ path: 'profile', tagName: 'user-profile' },
|
|
566
|
+
{ path: 'settings', tagName: 'user-settings' },
|
|
567
|
+
{ path: ':id', tagName: 'user-detail' }
|
|
568
|
+
]
|
|
569
|
+
}
|
|
570
|
+
];
|
|
571
|
+
|
|
572
|
+
// 对应的 URL:
|
|
573
|
+
// /user/profile
|
|
574
|
+
// /user/settings
|
|
575
|
+
// /user/123
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
#### 异步路由
|
|
579
|
+
|
|
580
|
+
支持异步组件加载,实现代码分割:
|
|
581
|
+
|
|
582
|
+
```typescript
|
|
583
|
+
const routes = [
|
|
584
|
+
{
|
|
585
|
+
path: '/dashboard',
|
|
586
|
+
component: async () => {
|
|
587
|
+
const module = await import('./pages/dashboard.js');
|
|
588
|
+
return module.default; // 返回包含 tagName 的对象
|
|
589
|
+
}
|
|
590
|
+
}
|
|
591
|
+
];
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
#### 路由缓存
|
|
595
|
+
|
|
596
|
+
使用 `keepAlive` 选项缓存组件实例,提升切换性能:
|
|
597
|
+
|
|
598
|
+
```typescript
|
|
599
|
+
const routes = [
|
|
600
|
+
{
|
|
601
|
+
path: '/profile',
|
|
602
|
+
tagName: 'user-profile',
|
|
603
|
+
keepAlive: true // 缓存组件实例
|
|
604
|
+
}
|
|
605
|
+
];
|
|
606
|
+
```
|
|
607
|
+
|
|
608
|
+
#### 路由模式
|
|
609
|
+
|
|
610
|
+
Solely 支持两种路由模式:
|
|
611
|
+
|
|
612
|
+
| 模式 | 说明 | URL 格式 | 适用场景 |
|
|
613
|
+
|---|---|---|---|
|
|
614
|
+
| `hash` | 基于 URL hash | `#/users/123` | 兼容旧浏览器,无需服务器配置 |
|
|
615
|
+
| `history` | 基于 HTML5 History API | `/users/123` | 更美观的 URL,需要服务器支持 |
|
|
616
|
+
|
|
617
|
+
```typescript
|
|
618
|
+
// Hash 模式(默认)
|
|
619
|
+
const router = createRouter({
|
|
620
|
+
routes,
|
|
621
|
+
mode: 'hash'
|
|
622
|
+
});
|
|
623
|
+
|
|
624
|
+
// History 模式
|
|
625
|
+
const router = createRouter({
|
|
626
|
+
routes,
|
|
627
|
+
mode: 'history',
|
|
628
|
+
base: '/app' // 应用基础路径
|
|
629
|
+
});
|
|
630
|
+
```
|
|
631
|
+
|
|
632
|
+
#### 路由监听
|
|
633
|
+
|
|
634
|
+
监听路由变化:
|
|
635
|
+
|
|
636
|
+
```typescript
|
|
637
|
+
// 添加监听器
|
|
638
|
+
const unsubscribe = router.listen(() => {
|
|
639
|
+
console.log('路由已变化');
|
|
640
|
+
});
|
|
641
|
+
|
|
642
|
+
// 移除监听器
|
|
643
|
+
unsubscribe();
|
|
644
|
+
```
|
|
645
|
+
|
|
646
|
+
#### 路由组件
|
|
647
|
+
|
|
648
|
+
Solely 提供了两个内置的路由组件:
|
|
649
|
+
|
|
650
|
+
**router-link**
|
|
651
|
+
|
|
652
|
+
```html
|
|
653
|
+
<!-- 基本用法 -->
|
|
654
|
+
<router-link to="/about">关于我们</router-link>
|
|
655
|
+
|
|
656
|
+
<!-- 带激活状态 -->
|
|
657
|
+
<router-link to="/users" active-class="active">用户列表</router-link>
|
|
658
|
+
|
|
659
|
+
<!-- 精确匹配 -->
|
|
660
|
+
<router-link to="/users" exact>用户列表</router-link>
|
|
661
|
+
|
|
662
|
+
<!-- 自定义链接内容 -->
|
|
663
|
+
<router-link to="/profile">
|
|
664
|
+
<img src="avatar.png" alt="个人资料">
|
|
665
|
+
<span>个人资料</span>
|
|
666
|
+
</router-link>
|
|
667
|
+
|
|
668
|
+
<!-- 自定义模式(移除 a 标签包裹) -->
|
|
669
|
+
<router-link to="/dashboard" custom>
|
|
670
|
+
<button @click="event.preventDefault()">仪表盘</button>
|
|
671
|
+
</router-link>
|
|
672
|
+
|
|
673
|
+
<!-- 预加载路由 -->
|
|
674
|
+
<router-link to="/heavy-page" prefetch>重型页面</router-link>
|
|
675
|
+
```
|
|
676
|
+
|
|
677
|
+
**router-view**
|
|
678
|
+
|
|
679
|
+
```html
|
|
680
|
+
<!-- 基本用法 -->
|
|
681
|
+
<router-view></router-view>
|
|
682
|
+
|
|
683
|
+
<!-- 嵌套路由视图 -->
|
|
684
|
+
<div class="layout">
|
|
685
|
+
<aside>
|
|
686
|
+
<router-link to="/user/profile">个人资料</router-link>
|
|
687
|
+
<router-link to="/user/settings">设置</router-link>
|
|
688
|
+
</aside>
|
|
689
|
+
<main>
|
|
690
|
+
<router-view></router-view>
|
|
691
|
+
</main>
|
|
692
|
+
</div>
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
#### 路由匹配规则
|
|
696
|
+
|
|
697
|
+
Solely 的路由匹配遵循以下优先级:
|
|
698
|
+
|
|
699
|
+
1. **精确匹配**:完全匹配路径
|
|
700
|
+
2. **动态参数**:`/users/:id` 匹配 `/users/123`
|
|
701
|
+
3. **通配符**:`*` 匹配所有未匹配的路径
|
|
702
|
+
|
|
703
|
+
```typescript
|
|
704
|
+
const routes = [
|
|
705
|
+
{ path: '/users', tagName: 'user-list' }, // 精确匹配 /users
|
|
706
|
+
{ path: '/users/:id', tagName: 'user-detail' }, // 匹配 /users/123
|
|
707
|
+
{ path: '*', tagName: 'not-found' } // 匹配所有其他路径
|
|
708
|
+
];
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
#### 路由元信息
|
|
712
|
+
|
|
713
|
+
使用路由元信息存储自定义数据:
|
|
714
|
+
|
|
715
|
+
```typescript
|
|
716
|
+
const routes = [
|
|
717
|
+
{
|
|
718
|
+
path: '/admin',
|
|
719
|
+
tagName: 'admin-panel',
|
|
720
|
+
meta: {
|
|
721
|
+
requiresAuth: true,
|
|
722
|
+
requiresAdmin: true,
|
|
723
|
+
title: '管理面板'
|
|
724
|
+
}
|
|
725
|
+
}
|
|
726
|
+
];
|
|
727
|
+
|
|
728
|
+
// 在守卫中使用
|
|
729
|
+
beforeEach: (to, from) => {
|
|
730
|
+
if (to.meta.requiresAuth && !isLoggedIn) {
|
|
731
|
+
return '/login';
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
## 📖 示例项目
|
|
737
|
+
|
|
738
|
+
查看 [examples](./examples) 目录获取更多示例:
|
|
739
|
+
|
|
740
|
+
- **计数器示例** (`examples/counter/`) - 基础交互示例
|
|
741
|
+
- **待办事项示例** (`examples/todo/`) - 列表管理和状态示例
|
|
742
|
+
- **表单示例** (`examples/form/`) - 表单处理和验证示例
|
|
743
|
+
- **天气示例** (`examples/weather/`) - 异步数据获取示例
|
|
744
|
+
|
|
745
|
+
### 运行示例
|
|
746
|
+
|
|
747
|
+
```bash
|
|
748
|
+
# 安装依赖
|
|
749
|
+
npm install
|
|
750
|
+
|
|
751
|
+
# 启动开发服务器
|
|
752
|
+
npm run dev
|
|
753
|
+
|
|
754
|
+
# 访问示例
|
|
755
|
+
# 打开浏览器访问 http://localhost:5173/examples/
|
|
756
|
+
```
|
|
757
|
+
|
|
758
|
+
## 🧪 测试
|
|
759
|
+
|
|
760
|
+
```bash
|
|
761
|
+
# 运行所有测试
|
|
762
|
+
npm test
|
|
763
|
+
|
|
764
|
+
# 运行测试并查看 UI
|
|
765
|
+
npm run test:ui
|
|
766
|
+
|
|
767
|
+
# 生成测试覆盖率报告
|
|
768
|
+
npm run test:coverage
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
## 🔧 构建和开发
|
|
772
|
+
|
|
773
|
+
```bash
|
|
774
|
+
# 构建生产版本
|
|
775
|
+
npm run build
|
|
776
|
+
|
|
777
|
+
# 本地预览构建结果
|
|
778
|
+
npm run preview
|
|
779
|
+
|
|
780
|
+
# 全局链接(用于本地测试)
|
|
781
|
+
npm run link
|
|
782
|
+
|
|
783
|
+
# 本地打包(用于其他项目引用)
|
|
784
|
+
npm run pack:local
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
## 🤝 贡献指南
|
|
788
|
+
|
|
789
|
+
欢迎贡献代码!请遵循以下步骤:
|
|
790
|
+
|
|
791
|
+
1. **Fork 仓库**:在 GitHub 上 fork 本项目
|
|
792
|
+
2. **克隆仓库**:`git clone https://github.com/your-username/solely.git`
|
|
793
|
+
3. **创建分支**:`git checkout -b feature/your-feature`
|
|
794
|
+
4. **安装依赖**:`npm install`
|
|
795
|
+
5. **开发和测试**:编写代码并运行测试
|
|
796
|
+
6. **提交代码**:`git commit -m "Add your feature"`
|
|
797
|
+
7. **推送到远程**:`git push origin feature/your-feature`
|
|
798
|
+
8. **创建 Pull Request**:在 GitHub 上创建 PR
|
|
799
|
+
|
|
800
|
+
### 代码规范
|
|
801
|
+
|
|
802
|
+
- 遵循 TypeScript 编码规范
|
|
803
|
+
- 确保所有测试通过
|
|
804
|
+
- 保持代码风格一致
|
|
805
|
+
- 提供清晰的注释
|
|
806
|
+
|
|
807
|
+
## 📄 许可证
|
|
808
|
+
|
|
809
|
+
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
|
|
810
|
+
|
|
811
|
+
## 🙏 致谢
|
|
812
|
+
|
|
813
|
+
感谢所有为这个项目做出贡献的人!
|
|
814
|
+
|
|
815
|
+
---
|
|
816
|
+
|
|
817
|
+
**Happy Coding with Solely! 🚀**
|