@bereasoftware/nexa 1.4.0 → 1.5.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.en.md +127 -98
- package/README.md +139 -97
- package/dist/bereasoftware-nexa-1.5.0.tgz +0 -0
- package/dist/nexa.cjs.js +226 -83
- package/dist/nexa.cjs.js.map +1 -1
- package/dist/nexa.es.js +486 -211
- package/dist/nexa.es.js.map +1 -1
- package/dist/nexa.iife.js +226 -83
- package/dist/nexa.iife.js.map +1 -1
- package/dist/nexa.umd.js +226 -83
- package/dist/nexa.umd.js.map +1 -1
- package/dist/types/dev-overlay/index.d.ts +7 -0
- package/dist/types/dev-overlay/overlay.d.ts +7 -0
- package/dist/types/dev-overlay/tracker.d.ts +2 -0
- package/dist/types/dev-overlay/types.d.ts +11 -0
- package/package.json +1 -1
- package/dist/bereasoftware-nexa-1.4.0.tgz +0 -0
|
@@ -4,9 +4,16 @@ export type { TrackedRequest, DevMetrics, DevOverlayConfig } from './types';
|
|
|
4
4
|
import { RequestTracker } from './tracker';
|
|
5
5
|
import { DevOverlayUI } from './overlay';
|
|
6
6
|
import type { DevOverlayConfig } from './types';
|
|
7
|
+
export declare const defaultDevOverlayConfig: DevOverlayConfig;
|
|
8
|
+
/**
|
|
9
|
+
* Create (or return) the singleton Dev Overlay instances.
|
|
10
|
+
*
|
|
11
|
+
* The `config` object overrides defaults exposed via `defaultDevOverlayConfig`.
|
|
12
|
+
*/
|
|
7
13
|
export declare function createDevOverlay(config?: DevOverlayConfig): {
|
|
8
14
|
tracker: RequestTracker;
|
|
9
15
|
ui: DevOverlayUI;
|
|
16
|
+
config: Required<DevOverlayConfig>;
|
|
10
17
|
};
|
|
11
18
|
export declare function getDevOverlay(): {
|
|
12
19
|
tracker: RequestTracker | null;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
import type { DevOverlayConfig } from './types';
|
|
1
2
|
import type { RequestTracker } from './tracker';
|
|
2
3
|
export declare class DevOverlayUI {
|
|
3
4
|
private panel;
|
|
5
|
+
private floatingIcon;
|
|
4
6
|
private tracker;
|
|
5
7
|
private visible;
|
|
6
8
|
private selectedRequest;
|
|
@@ -27,4 +29,9 @@ export declare class DevOverlayUI {
|
|
|
27
29
|
private truncateUrl;
|
|
28
30
|
private formatJson;
|
|
29
31
|
private canUseDOM;
|
|
32
|
+
private createFloatingIcon;
|
|
33
|
+
private showFloatingIcon;
|
|
34
|
+
private hideFloatingIcon;
|
|
35
|
+
private applyConfigToUI;
|
|
36
|
+
refreshConfig(newConfig?: Required<DevOverlayConfig>): void;
|
|
30
37
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { TrackedRequest, DevMetrics, DevOverlayConfig } from './types';
|
|
2
|
+
export declare function loadPersistedConfig(): Partial<DevOverlayConfig>;
|
|
2
3
|
export declare class RequestTracker {
|
|
3
4
|
private history;
|
|
4
5
|
private maxHistory;
|
|
@@ -12,5 +13,6 @@ export declare class RequestTracker {
|
|
|
12
13
|
clear(): void;
|
|
13
14
|
onChange(listener: (request: TrackedRequest) => void): () => void;
|
|
14
15
|
getConfig(): Required<DevOverlayConfig>;
|
|
16
|
+
updateConfig(partial: Partial<DevOverlayConfig>): Required<DevOverlayConfig>;
|
|
15
17
|
private generateId;
|
|
16
18
|
}
|
|
@@ -30,4 +30,15 @@ export interface DevOverlayConfig {
|
|
|
30
30
|
keyboardShortcut?: string;
|
|
31
31
|
position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
|
|
32
32
|
theme?: 'dark' | 'light';
|
|
33
|
+
/**
|
|
34
|
+
* When true the floating button and overlay UI will only be created
|
|
35
|
+
* when running in a development environment. Defaults to true.
|
|
36
|
+
*/
|
|
37
|
+
devOnly?: boolean;
|
|
38
|
+
/** Size in pixels for the floating button (width & height). Default 48 */
|
|
39
|
+
floatingButtonSize?: number;
|
|
40
|
+
/** Offset in pixels from the viewport edges. Default 24 */
|
|
41
|
+
floatingButtonOffset?: number;
|
|
42
|
+
/** Theme for the floating button. 'inherit' uses overlay theme. Default 'inherit' */
|
|
43
|
+
floatingButtonTheme?: 'inherit' | 'dark' | 'light';
|
|
33
44
|
}
|
package/package.json
CHANGED
|
Binary file
|