@doenet/doenetml-iframe 0.7.0-alpha10

package/index.d.ts

@@ -0,0 +1,81 @@
+import { default as default_2 } from 'react';
+import { DoenetEditor as DoenetEditor_2 } from '@doenet/doenetml';
+import { DoenetViewer as DoenetViewer_2 } from '@doenet/doenetml';
+import { mathjaxConfig } from '@doenet/utils';
+
+/**
+ * Render Doenet Editor constrained to an iframe. A URL pointing to a version of DoenetML
+ * standalone must be provided (along with a URL to the corresponding CSS file).
+ *
+ * Parameters being passed to the underlying DoenetML component are passed via the `DoenetEditorProps` prop.
+ * However, only serializable parameters may be passed. E.g., callbacks **cannot** be passed to the underlying
+ * DoenetML component. Instead you must use the message passing interface of `DoenetEditor` to communicate
+ * with the underlying DoenetML component.
+ */
+export declare function DoenetEditor({ doenetML, standaloneUrl: specifiedStandaloneUrl, cssUrl: specifiedCssUrl, doenetmlVersion: specifiedDoenetmlVersion, width, height, ...doenetEditorProps }: DoenetEditorIframeProps): default_2.JSX.Element;
+
+export declare type DoenetEditorIframeProps = DoenetEditorProps & {
+    doenetML: string;
+    /**
+     * The URL of a standalone DoenetML bundle. This may be from the CDN.
+     */
+    standaloneUrl?: string;
+    /**
+     * The URL of a CSS file that styles the standalone DoenetML bundle.
+     */
+    cssUrl?: string;
+    /**
+     * The version of standalone DoenetML bundle if urls are not provided
+     */
+    doenetmlVersion?: string;
+    /**
+     * The width of the iframe (and the width of the editor-viewer widget)
+     */
+    width?: string;
+    /**
+     * The height of the iframe (and the height of the editor-viewer widget)
+     */
+    height?: string;
+};
+
+declare type DoenetEditorProps = Omit<default_2.ComponentProps<typeof DoenetEditor_2>, "doenetML" | "width" | "height">;
+
+/**
+ * Render Doenet viewer constrained to an iframe. A URL pointing to a version of DoenetML
+ * standalone must be provided (along with a URL to the corresponding CSS file).
+ *
+ * Parameters being passed to the underlying DoenetML component are passed via the `DoenetViewerProps` prop.
+ * However, only serializable parameters may be passed. E.g., callbacks **cannot** be passed to the underlying
+ * 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, scrollableContainer: _scrollableContainer, ...doenetViewerProps }: DoenetViewerIframeProps): default_2.JSX.Element;
+
+export declare type DoenetViewerIframeProps = DoenetViewerProps & {
+    doenetML: string;
+    /**
+     * The URL of a standalone DoenetML bundle. This may be from the CDN.
+     */
+    standaloneUrl?: string;
+    /**
+     * The URL of a CSS file that styles the standalone DoenetML bundle.
+     */
+    cssUrl?: string;
+    /**
+     * The version of standalone DoenetML bundle if urls are not provided
+     */
+    doenetmlVersion?: string;
+    /**
+     * Added to remove the scrollableContainer attribute from DoenetViewerProps
+     * that will be stringified (as it has circular structure)
+     */
+    scrollableContainer?: any;
+};
+
+declare type DoenetViewerProps = Omit<default_2.ComponentProps<typeof DoenetViewer_2>, "doenetML" | "scrollableContainer">;
+
+export { mathjaxConfig }
+
+export declare const version: string;
+
+export { }