@doenet/doenetml-iframe 0.7.0-alpha13 → 0.7.0-alpha15

package/README.md

@@ -0,0 +1,11 @@
+# DoenetML IFrame Renderer
+
+This workspace contains a DoenetML viewer and editor that render inside of an iframe.
+This allows DoenetML to be used without affecting the surrounding page.
+It also allows multiple versions of DoenetML to be used at the same time.
+
+## Development
+
+Source code in `src/iframe-viewer-index.ts` and `src/iframe-editor-index.ts`
+is pre-compiled and included directly in the generated iframe.
+Source code in `src/index.tsx` is compiled into the `DoenetViewer` and `DoenetEditor` components.

package/index.d.ts

@@ -1,7 +1,9 @@
 import { default as default_2 } from 'react';
 import { DoenetEditor as DoenetEditor_2 } from '@doenet/doenetml';
 import { DoenetViewer as DoenetViewer_2 } from '@doenet/doenetml';
+import { ErrorDescription } from '@doenet/utils';
 import { mathjaxConfig } from '@doenet/utils';
+import { WarningDescription } from '@doenet/utils';
 
 /**
  * Render Doenet Editor constrained to an iframe. A URL pointing to a version of DoenetML
@@ -47,7 +49,7 @@ export declare type DoenetEditorIframeProps = DoenetEditorProps & {
     height?: string;
 };
 
-declare type DoenetEditorProps = Omit<React.ComponentProps<typeof DoenetEditor_2>, "doenetML" | "width" | "height">;
+declare type DoenetEditorProps = Omit<React.ComponentProps<typeof DoenetEditor_2>, "doenetML" | "width" | "height" | "keyboardIsOutsideIframe">;
 
 /**
  * Render Doenet viewer constrained to an iframe. A URL pointing to a version of DoenetML
@@ -58,7 +60,7 @@ declare type DoenetEditorProps = Omit<React.ComponentProps<typeof DoenetEditor_2
  * DoenetML component. Instead you must use the message passing interface of `DoenetViewer` to communicate
  * with the underlying DoenetML component.
  */
-export declare function DoenetViewer({ doenetML, standaloneUrl: specifiedStandaloneUrl, cssUrl: specifiedCssUrl, doenetmlVersion: specifiedDoenetmlVersion, autodetectVersion, scrollableContainer: _scrollableContainer, ...doenetViewerProps }: DoenetViewerIframeProps): default_2.JSX.Element | null;
+export declare function DoenetViewer({ doenetML, standaloneUrl: specifiedStandaloneUrl, cssUrl: specifiedCssUrl, doenetmlVersion: specifiedDoenetmlVersion, autodetectVersion, ...doenetViewerProps }: DoenetViewerIframeProps): default_2.JSX.Element | null;
 
 export declare type DoenetViewerIframeProps = DoenetViewerProps & {
     doenetML: string;
@@ -83,17 +85,16 @@ export declare type DoenetViewerIframeProps = DoenetViewerProps & {
      * overwriting any doenetmlVersion or urls provided
      */
     autodetectVersion?: boolean;
-    /**
-     * Added to remove the scrollableContainer attribute from DoenetViewerProps
-     * that will be stringified (as it has circular structure)
-     */
-    scrollableContainer?: any;
 };
 
-declare type DoenetViewerProps = Omit<React.ComponentProps<typeof DoenetViewer_2>, "doenetML" | "scrollableContainer">;
+declare type DoenetViewerProps = Omit<React.ComponentProps<typeof DoenetViewer_2>, "doenetML" | "scrollableContainer" | "keyboardIsOutsideIframe">;
+
+export { ErrorDescription }
 
 export { mathjaxConfig }
 
 export declare const version: string;
 
+export { WarningDescription }
+
 export { }