@ikonai/sdk-react-ui 1.0.58 → 1.0.60
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/app/use-ikon-app.d.ts +6 -0
- package/debug/debug-overlay.d.ts +22 -0
- package/index.d.ts +2 -0
- package/index.js +1393 -1166
- package/package.json +1 -1
- package/shadertoy/shadertoy-gl.d.ts +7 -0
package/app/use-ikon-app.d.ts
CHANGED
|
@@ -94,6 +94,12 @@ export interface UseIkonAppResult {
|
|
|
94
94
|
* When set, the app should show an access denied screen instead of the normal UI.
|
|
95
95
|
*/
|
|
96
96
|
accessDeniedReason: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* True when the server rejected the connection because it is at capacity (the app instance
|
|
99
|
+
* reached its maximum client limit). Terminal — the SDK does not retry. The app should show an
|
|
100
|
+
* "at capacity" message (the offline overlay) rather than a transient offline/reconnecting state.
|
|
101
|
+
*/
|
|
102
|
+
isServerFull: boolean;
|
|
97
103
|
/**
|
|
98
104
|
* UI stores for rendering.
|
|
99
105
|
*/
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* On-screen debug overlay, enabled with `?ikon-debug-overlay=true`.
|
|
3
|
+
*
|
|
4
|
+
* Surfaces the environment, connection-state timeline, and ALL captured JS errors + SDK log
|
|
5
|
+
* events directly on screen — invaluable for debugging on devices with no usable console
|
|
6
|
+
* (smart TVs, phones, kiosks). This is a DISTINCT opt-in from `ikon-debug` (verbose logging /
|
|
7
|
+
* devtools): debug mode does NOT force the visual overlay, since on a desktop you usually want
|
|
8
|
+
* a console, not a panel over the UI.
|
|
9
|
+
*
|
|
10
|
+
* Rendered automatically by {@link IkonApp} and the (deprecated) ConnectionStateRenderer, so
|
|
11
|
+
* apps get it for free; it returns null unless the param is set, making it zero-cost when off.
|
|
12
|
+
*/
|
|
13
|
+
export declare const DEBUG_OVERLAY_ENABLED: boolean;
|
|
14
|
+
export interface DebugOverlayProps {
|
|
15
|
+
/** Current connection state, shown in the header. When 'connected'/'reconnecting' the panel
|
|
16
|
+
* renders as a small collapsible corner badge instead of a full-screen panel. */
|
|
17
|
+
state?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The overlay component. Returns null unless `?ikon-debug-overlay=true` is set.
|
|
21
|
+
*/
|
|
22
|
+
export declare function DebugOverlay({ state }: DebugOverlayProps): import("react/jsx-runtime").JSX.Element | null;
|
package/index.d.ts
CHANGED
|
@@ -17,3 +17,5 @@ export { ConnectionStateRenderer, type ConnectedRenderProps, type ConnectionStat
|
|
|
17
17
|
export { useLazyFont, useToasts, useIkonReactive, useReactive, type Toast } from './hooks';
|
|
18
18
|
export { I18nProvider, useI18n, type I18nContextValue, type I18nProviderProps } from './i18n';
|
|
19
19
|
export { InspectOverlay, type InspectElementPayload } from './inspect/inspect-overlay';
|
|
20
|
+
export { DebugOverlay, DEBUG_OVERLAY_ENABLED, type DebugOverlayProps } from './debug/debug-overlay';
|
|
21
|
+
export { randomUuid } from '../../sdk/src/index.ts';
|