@visulima/vite-overlay 2.0.10 → 2.0.12
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/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
## @visulima/vite-overlay [2.0.12](https://github.com/visulima/visulima/compare/%40visulima%2Fvite-overlay%402.0.11...%40visulima%2Fvite-overlay%402.0.12) (2026-08-02)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Dependencies
|
|
5
|
+
|
|
6
|
+
* **@visulima/error:** upgraded to 6.1.0
|
|
7
|
+
* **@visulima/path:** upgraded to 3.1.0
|
|
8
|
+
|
|
9
|
+
## @visulima/vite-overlay [2.0.11](https://github.com/visulima/visulima/compare/%40visulima%2Fvite-overlay%402.0.10...%40visulima%2Fvite-overlay%402.0.11) (2026-07-27)
|
|
10
|
+
|
|
1
11
|
## @visulima/vite-overlay [2.0.10](https://github.com/visulima/visulima/compare/%40visulima%2Fvite-overlay%402.0.9...%40visulima%2Fvite-overlay%402.0.10) (2026-07-27)
|
|
2
12
|
|
|
3
13
|
## @visulima/vite-overlay [2.0.9](https://github.com/visulima/visulima/compare/%40visulima%2Fvite-overlay%402.0.8...%40visulima%2Fvite-overlay%402.0.9) (2026-07-27)
|
package/dist/index.d.ts
CHANGED
|
@@ -4,22 +4,22 @@ import { SolutionFinder } from '@visulima/error/solution';
|
|
|
4
4
|
export type { Solution, SolutionFinder } from '@visulima/error/solution';
|
|
5
5
|
import { Properties } from 'csstype';
|
|
6
6
|
/**
|
|
7
|
-
* Framework hint used to route framework-aware solutions. When omitted, the plugin
|
|
8
|
-
* auto-detects the framework from the configured Vite plugins.
|
|
9
|
-
*/
|
|
7
|
+
* Framework hint used to route framework-aware solutions. When omitted, the plugin
|
|
8
|
+
* auto-detects the framework from the configured Vite plugins.
|
|
9
|
+
*/
|
|
10
10
|
type Framework = "preact" | "react" | "solid" | "svelte" | "vue";
|
|
11
11
|
/**
|
|
12
|
-
* Balloon position options
|
|
13
|
-
*/
|
|
12
|
+
* Balloon position options
|
|
13
|
+
*/
|
|
14
14
|
type BalloonPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right";
|
|
15
15
|
/**
|
|
16
|
-
* Custom style options for the balloon trigger
|
|
17
|
-
* Can be either a CSS string or a CSS.Properties object
|
|
18
|
-
*/
|
|
16
|
+
* Custom style options for the balloon trigger
|
|
17
|
+
* Can be either a CSS string or a CSS.Properties object
|
|
18
|
+
*/
|
|
19
19
|
type BalloonStyle = string | Properties;
|
|
20
20
|
/**
|
|
21
|
-
* Balloon configuration options
|
|
22
|
-
*/
|
|
21
|
+
* Balloon configuration options
|
|
22
|
+
*/
|
|
23
23
|
interface BalloonConfig {
|
|
24
24
|
readonly enabled?: boolean;
|
|
25
25
|
readonly icon?: string;
|
|
@@ -27,122 +27,113 @@ interface BalloonConfig {
|
|
|
27
27
|
readonly style?: BalloonStyle;
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
* Overlay configuration options
|
|
31
|
-
*/
|
|
30
|
+
* Overlay configuration options
|
|
31
|
+
*/
|
|
32
32
|
interface OverlayConfig {
|
|
33
33
|
readonly balloon?: BalloonConfig;
|
|
34
34
|
/**
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
35
|
+
* Custom CSS to inject into the overlay for styling customization.
|
|
36
|
+
* This CSS will be injected into the shadow DOM and can be used to override
|
|
37
|
+
* the default styles of the overlay and button elements.
|
|
38
|
+
* Can be either a CSS string or a CSS.Properties object.
|
|
39
|
+
*/
|
|
40
40
|
readonly customCSS?: string | Properties;
|
|
41
41
|
}
|
|
42
42
|
/**
|
|
43
|
-
* Options accepted by the `@visulima/vite-overlay` plugin.
|
|
44
|
-
*/
|
|
43
|
+
* Options accepted by the `@visulima/vite-overlay` plugin.
|
|
44
|
+
*/
|
|
45
45
|
interface VisulimaViteOverlayOptions {
|
|
46
46
|
/**
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
47
|
+
* Whether client runtime errors are forwarded to (and displayed in) the overlay.
|
|
48
|
+
* @default true
|
|
49
|
+
*/
|
|
50
50
|
readonly forwardConsole?: boolean;
|
|
51
51
|
/**
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
52
|
+
* Console method names to forward from the client (e.g. `["error", "warn"]`).
|
|
53
|
+
* @default ["error"]
|
|
54
|
+
*/
|
|
55
55
|
readonly forwardedConsoleMethods?: string[];
|
|
56
56
|
/**
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
57
|
+
* Explicitly set the framework used for framework-aware hints. When omitted, the plugin
|
|
58
|
+
* auto-detects React / Vue / Svelte / Preact / Solid from the configured Vite plugins.
|
|
59
|
+
*/
|
|
60
60
|
readonly framework?: Framework;
|
|
61
61
|
/**
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
62
|
+
* Capture process-wide `unhandledRejection` events and render them in the overlay.
|
|
63
|
+
* Set to `false` to leave Node's default crash semantics untouched (useful when other
|
|
64
|
+
* tooling in the dev process produces unrelated rejections).
|
|
65
|
+
* @default true
|
|
66
|
+
*/
|
|
67
67
|
readonly interceptUnhandledRejection?: boolean;
|
|
68
68
|
/**
|
|
69
|
-
|
|
70
|
-
|
|
69
|
+
* @deprecated Use {@link VisulimaViteOverlayOptions.forwardConsole} instead.
|
|
70
|
+
*/
|
|
71
71
|
readonly logClientRuntimeError?: boolean;
|
|
72
72
|
/**
|
|
73
|
-
|
|
74
|
-
|
|
73
|
+
* Overlay UI configuration (balloon button, custom CSS).
|
|
74
|
+
*/
|
|
75
75
|
readonly overlay?: OverlayConfig;
|
|
76
76
|
/**
|
|
77
|
-
|
|
78
|
-
|
|
77
|
+
* Custom Preact plugin name to match during auto-detection.
|
|
78
|
+
*/
|
|
79
79
|
readonly preactPluginName?: string;
|
|
80
80
|
/**
|
|
81
|
-
|
|
82
|
-
|
|
81
|
+
* Custom React plugin name to match during auto-detection.
|
|
82
|
+
*/
|
|
83
83
|
readonly reactPluginName?: string;
|
|
84
84
|
/**
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
85
|
+
* @deprecated Misspelling of {@link VisulimaViteOverlayOptions.showBalloonButton}. Kept for
|
|
86
|
+
* backward compatibility; prefer `showBalloonButton` or `overlay.balloon.enabled`.
|
|
87
|
+
*/
|
|
88
88
|
readonly showBallonButton?: boolean;
|
|
89
89
|
/**
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
90
|
+
* Whether to show the balloon button.
|
|
91
|
+
* @default true
|
|
92
|
+
*/
|
|
93
93
|
readonly showBalloonButton?: boolean;
|
|
94
94
|
/**
|
|
95
|
-
|
|
96
|
-
|
|
95
|
+
* Custom Solid plugin name to match during auto-detection.
|
|
96
|
+
*/
|
|
97
97
|
readonly solidPluginName?: string;
|
|
98
98
|
/**
|
|
99
|
-
|
|
100
|
-
|
|
99
|
+
* Custom solution finders to run before the built-in finders.
|
|
100
|
+
*/
|
|
101
101
|
readonly solutionFinders?: SolutionFinder[];
|
|
102
102
|
/**
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
* Custom Svelte plugin name to match during auto-detection.
|
|
104
|
+
*/
|
|
105
105
|
readonly sveltePluginName?: string;
|
|
106
106
|
/**
|
|
107
|
-
|
|
108
|
-
|
|
107
|
+
* Custom Vue plugin name to match during auto-detection.
|
|
108
|
+
*/
|
|
109
109
|
readonly vuePluginName?: string;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
|
-
* Creates a solution finder specifically designed for Vite-related errors.
|
|
113
|
-
* Provides intelligent suggestions for common Vite import resolution and configuration issues.
|
|
114
|
-
* @param rootPath The root path of the project
|
|
115
|
-
* @returns A solution finder object for Vite-specific error handling
|
|
116
|
-
*/
|
|
112
|
+
* Creates a solution finder specifically designed for Vite-related errors.
|
|
113
|
+
* Provides intelligent suggestions for common Vite import resolution and configuration issues.
|
|
114
|
+
* @param rootPath The root path of the project
|
|
115
|
+
* @returns A solution finder object for Vite-specific error handling
|
|
116
|
+
*/
|
|
117
117
|
declare const createViteSolutionFinder: (rootPath: string) => SolutionFinder;
|
|
118
118
|
/**
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
* @param options
|
|
127
|
-
* @param options.
|
|
128
|
-
* @param options.
|
|
129
|
-
* @param
|
|
130
|
-
* @param options.
|
|
131
|
-
* @param options.
|
|
132
|
-
* @param options.
|
|
133
|
-
* @param options.
|
|
134
|
-
* @param options.
|
|
135
|
-
* @param options.
|
|
136
|
-
* @
|
|
137
|
-
|
|
138
|
-
* @param options.showBalloonButton Whether to show the balloon button (optional)
|
|
139
|
-
* @param options.showBallonButton [deprecated] Misspelling of showBalloonButton
|
|
140
|
-
* @param options.overlay Overlay configuration (optional)
|
|
141
|
-
* @returns The Vite plugin configuration
|
|
142
|
-
*/
|
|
119
|
+
* Main Vite plugin for error overlay functionality.
|
|
120
|
+
* Intercepts runtime errors and displays them in a user-friendly overlay.
|
|
121
|
+
* @param options Plugin configuration options
|
|
122
|
+
* @param options.forwardConsole Whether to log client runtime errors (optional)
|
|
123
|
+
* @param options.forwardedConsoleMethods Array of console method names to forward (optional)
|
|
124
|
+
* @param [options.logClientRuntimeError] [deprecated] Use forwardConsole instead
|
|
125
|
+
* @param options.reactPluginName Custom React plugin name (optional)
|
|
126
|
+
* @param options.solutionFinders Custom solution finders (optional)
|
|
127
|
+
* @param options.vuePluginName Custom Vue plugin name (optional)
|
|
128
|
+
* @param options.sveltePluginName Custom Svelte plugin name (optional)
|
|
129
|
+
* @param options.preactPluginName Custom Preact plugin name (optional)
|
|
130
|
+
* @param options.solidPluginName Custom Solid plugin name (optional)
|
|
131
|
+
* @param options.framework Explicit framework override; skips auto-detection (optional)
|
|
132
|
+
* @param options.interceptUnhandledRejection Capture process-wide unhandled rejections (optional, default true)
|
|
133
|
+
* @param options.showBalloonButton Whether to show the balloon button (optional)
|
|
134
|
+
* @param options.showBallonButton [deprecated] Misspelling of showBalloonButton
|
|
135
|
+
* @param options.overlay Overlay configuration (optional)
|
|
136
|
+
* @returns The Vite plugin configuration
|
|
137
|
+
*/
|
|
143
138
|
declare const errorOverlayPlugin: (options?: VisulimaViteOverlayOptions) => Plugin;
|
|
144
|
-
/**
|
|
145
|
-
* Default export of the Vite error overlay plugin.
|
|
146
|
-
* Use this plugin to enable error overlay functionality in your Vite project.
|
|
147
|
-
*/
|
|
148
139
|
export { type BalloonConfig, type BalloonPosition, type BalloonStyle, type Framework, type OverlayConfig, type VisulimaViteOverlayOptions, createViteSolutionFinder, errorOverlayPlugin as default };
|