lumen-tour 0.2.0 → 0.3.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 +1 -1
- package/dist/lumen-tour.cjs +0 -0
- package/dist/lumen-tour.es.js +0 -0
- package/dist/overlay.d.ts +5 -3
- package/dist/types.d.ts +13 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -70,7 +70,7 @@ tour.start();
|
|
|
70
70
|
| `steps` | `TourStep[]` | (必填) | 引导步骤列表 |
|
|
71
71
|
| `texts` | `Partial<ButtonTexts>` | 见下 | 覆盖按钮文案 |
|
|
72
72
|
| `overlayColor` | `string` | `rgba(0,0,0,0.5)` | 遮罩颜色 |
|
|
73
|
-
| `padding` | `number \| [
|
|
73
|
+
| `padding` | `number \| number[]` | `8` | 挖孔相对目标元素的内边距(px),CSS 风格简写:`number`/`[v]` 四周等距,`[t, h]` 上下 `t`、左右 `h`,`[t, h, b]` 上 `t`、左右 `h`、下 `b`,`[t, r, b, l]` 上/右/下/左独立控制 |
|
|
74
74
|
| `hideSkipOnLast` | `boolean` | `false` | 到达最后一步时是否隐藏"跳过"按钮 |
|
|
75
75
|
| `keyboard` | `boolean` | `true` | 是否启用键盘导航(→ 下一步、← 上一步、Esc 跳过) |
|
|
76
76
|
| `onNext` | `(ctx) => void \| boolean \| Promise<void \| boolean>` | — | 点击"下一步"时触发;返回 `false` 可阻止前进(支持异步校验) |
|
package/dist/lumen-tour.cjs
CHANGED
|
Binary file
|
package/dist/lumen-tour.es.js
CHANGED
|
Binary file
|
package/dist/overlay.d.ts
CHANGED
|
@@ -7,10 +7,12 @@ export declare class Overlay {
|
|
|
7
7
|
readonly el: HTMLElement;
|
|
8
8
|
private color;
|
|
9
9
|
constructor(root: HTMLElement, color?: string);
|
|
10
|
-
/** 按目标元素矩形(视口坐标)+ padding 更新挖孔位置 */
|
|
10
|
+
/** 按目标元素矩形(视口坐标)+ 四方向 padding 更新挖孔位置 */
|
|
11
11
|
update(rect: Rect, padding: {
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
top: number;
|
|
13
|
+
right: number;
|
|
14
|
+
bottom: number;
|
|
15
|
+
left: number;
|
|
14
16
|
}): void;
|
|
15
17
|
hide(): void;
|
|
16
18
|
destroy(): void;
|
package/dist/types.d.ts
CHANGED
|
@@ -7,9 +7,20 @@ export interface StepContext {
|
|
|
7
7
|
/** 当前步骤配置 */
|
|
8
8
|
step: TourStep;
|
|
9
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* padding 取值,CSS 风格简写(数组语义与 CSS margin/padding 一致):
|
|
12
|
+
* number → 四周等距;
|
|
13
|
+
* [v] → 四周等距 v;
|
|
14
|
+
* [t, h] → 上下 t、左右 h;
|
|
15
|
+
* [t, h, b] → 上 t、左右 h、下 b;
|
|
16
|
+
* [t, r, b, l] → 上、右、下、左各方向独立。
|
|
17
|
+
*/
|
|
18
|
+
export type PaddingInput = number | number[];
|
|
10
19
|
export interface TourStep {
|
|
11
20
|
/** 必填:目标元素选择器或元素本身 */
|
|
12
21
|
target: string | HTMLElement;
|
|
22
|
+
/** 挖孔相对目标元素的内边距(CSS 风格简写),设置后整体覆盖全局 padding */
|
|
23
|
+
padding?: PaddingInput;
|
|
13
24
|
/** 卡片相对目标的方向,默认自动(下方优先,放不下翻转到上方) */
|
|
14
25
|
placement?: import('./position').Placement;
|
|
15
26
|
/** 卡片标题,支持受限 HTML(白名单清洗:剥离 script/事件处理器/危险协议) */
|
|
@@ -35,11 +46,8 @@ export interface TourOptions {
|
|
|
35
46
|
texts?: Partial<ButtonTexts>;
|
|
36
47
|
/** 遮罩颜色,默认 rgba(0,0,0,0.5) */
|
|
37
48
|
overlayColor?: string;
|
|
38
|
-
/**
|
|
39
|
-
|
|
40
|
-
* 传 number 则四周等距;传 [x, y] 则水平 x、垂直 y。
|
|
41
|
-
*/
|
|
42
|
-
padding?: number | [number, number];
|
|
49
|
+
/** 挖孔相对目标元素的内边距,默认 8;CSS 风格简写(见 PaddingInput) */
|
|
50
|
+
padding?: PaddingInput;
|
|
43
51
|
/** 到达最后一步时是否隐藏"跳过"按钮,默认 false(保留显示) */
|
|
44
52
|
hideSkipOnLast?: boolean;
|
|
45
53
|
/** 键盘导航(→ 下一步、← 上一步、Esc 跳过),默认 true */
|