@micromag/viewer 0.3.832 → 0.4.6

package/es/index.d.ts

@@ -0,0 +1,95 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Story, Visitor, TrackingVariables, ViewerTheme, DeviceScreen, RenderContext, Ref } from '@micromag/core';
+import React from 'react';
+
+interface ViewerContainerProps {
+    story?: Story | null;
+    paused?: boolean;
+    muted?: boolean;
+    screen?: string;
+    screenComponents?: Record<string, unknown> | null;
+    memoryRouter?: boolean;
+    basePath?: string | null;
+    routes?: unknown;
+    withoutRouter?: boolean;
+    googleApiKey?: string | null;
+    visitor?: Visitor | null;
+    locale?: string;
+    locales?: string[];
+    translations?: Record<string, string> | null;
+    pathWithIndex?: boolean;
+    trackingVariables?: TrackingVariables | null;
+    trackingDisabled?: boolean;
+    trackingPaused?: boolean;
+    settings?: Record<string, unknown> | null;
+    children?: (...args: unknown[]) => void;
+}
+declare function ViewerContainer({ story, paused, muted, screenComponents, memoryRouter, basePath, routes, withoutRouter, googleApiKey, visitor, locale, locales, translations, pathWithIndex, trackingVariables, trackingDisabled, trackingPaused, settings, ...otherProps }: ViewerContainerProps): react_jsx_runtime.JSX.Element;
+
+interface ViewerProps {
+    story?: Story | null;
+    basePath?: string | null;
+    theme?: ViewerTheme | null;
+    width?: number | null;
+    height?: number | null;
+    screen?: string | null;
+    screenState?: string | null;
+    deviceScreens?: DeviceScreen[];
+    renderContext?: RenderContext;
+    onScreenChange?: ((...args: unknown[]) => void) | null;
+    tapNextScreenWidthPercent?: number;
+    tapMaximumDuration?: number;
+    longPressPauseDelay?: number;
+    storyIsParsed?: boolean;
+    neighborScreensActive?: number;
+    neighborScreenOffset?: number;
+    neighborScreenScale?: number;
+    neighborPreloadDelay?: number;
+    neighborPreloadBackward?: number;
+    neighborPreloadScreens?: number | null;
+    topSafezoneHeight?: number | null;
+    bottomSafezoneHeight?: number | null;
+    menuDotsButtons?: React.ReactNode | null;
+    menuIsScreenWidth?: boolean;
+    menuHeader?: React.ReactNode | null;
+    menuFooter?: React.ReactNode | null;
+    menuItems?: (string | React.ReactNode)[];
+    shareBasePath?: string | null;
+    shareOptions?: string[] | null;
+    afterShareMenuButton?: React.ReactNode | null;
+    beforeScreensMenuButton?: React.ReactNode | null;
+    backToFirstScreenTimeout?: number | null;
+    closeable?: boolean;
+    readyWithoutSize?: boolean;
+    withMetadata?: boolean;
+    withMicromagBranding?: boolean;
+    withoutGestures?: boolean;
+    withoutMenu?: boolean;
+    withoutScreensMenu?: boolean;
+    withoutShareMenu?: boolean;
+    withoutMenuShadow?: boolean;
+    withoutFullscreen?: boolean;
+    withoutNavigationArrow?: boolean;
+    withoutTransitions?: boolean;
+    withNeighborScreens?: boolean;
+    withFullscreenWebView?: boolean;
+    withNavigationHint?: boolean | string;
+    withoutPlaybackControls?: boolean;
+    withoutAutoUnmute?: boolean;
+    onClose?: ((...args: unknown[]) => void) | null;
+    onInteraction?: ((...args: unknown[]) => void) | null;
+    onEnd?: ((...args: unknown[]) => void) | null;
+    onViewModeChange?: ((...args: unknown[]) => void) | null;
+    onMenuChange?: ((...args: unknown[]) => void) | null;
+    currentScreenMedia?: Ref | null;
+    screensMedias?: Ref | null;
+    screenSizeOptions?: {
+        withoutMaxSize?: boolean;
+        desktopHeightRatio?: number;
+        screenRatio?: number;
+    } | null;
+    className?: string | null;
+}
+declare function Viewer({ story, basePath, theme: viewerTheme, width, height, screen: screenId, screenState, deviceScreens, renderContext, tapNextScreenWidthPercent, tapMaximumDuration, longPressPauseDelay, storyIsParsed, neighborScreensActive, neighborScreenOffset, neighborScreenScale, neighborPreloadDelay, neighborPreloadBackward, neighborPreloadScreens, topSafezoneHeight, bottomSafezoneHeight, menuIsScreenWidth, menuHeader, menuFooter, menuItems, shareBasePath, shareOptions, afterShareMenuButton, beforeScreensMenuButton, backToFirstScreenTimeout, menuDotsButtons, closeable, readyWithoutSize, withMetadata, withMicromagBranding, withoutGestures, withoutMenu, withoutScreensMenu, withoutShareMenu, withoutMenuShadow, withoutFullscreen, withoutNavigationArrow, withoutTransitions, withNeighborScreens, withFullscreenWebView, withNavigationHint, withoutPlaybackControls, withoutAutoUnmute, onClose: onCloseViewer, onInteraction, onEnd, onScreenChange, onViewModeChange, onMenuChange, currentScreenMedia, screensMedias, screenSizeOptions, className, }: ViewerProps): react_jsx_runtime.JSX.Element;
+
+export { Viewer, ViewerContainer as default };