@doenet/doenetml-iframe 0.7.0-alpha10 → 0.7.0-alpha12

package/index.d.ts

@@ -12,22 +12,31 @@ import { mathjaxConfig } from '@doenet/utils';
  * 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 function DoenetEditor({ doenetML, standaloneUrl: specifiedStandaloneUrl, cssUrl: specifiedCssUrl, doenetmlVersion: specifiedDoenetmlVersion, width, height, autodetectVersion, ...doenetEditorProps }: DoenetEditorIframeProps): default_2.JSX.Element | null;
 
 export declare type DoenetEditorIframeProps = DoenetEditorProps & {
     doenetML: string;
     /**
      * The URL of a standalone DoenetML bundle. This may be from the CDN.
+     * If autodetectVersion is `true` and a version is detected, this URL is ignored.
      */
     standaloneUrl?: string;
     /**
      * The URL of a CSS file that styles the standalone DoenetML bundle.
+     * If autodetectVersion is `true` and a version is detected, this URL is ignored.
      */
     cssUrl?: string;
     /**
-     * The version of standalone DoenetML bundle if urls are not provided
+     * The version of standalone DoenetML bundle if urls are not provided.
+     * If autodetectVersion is `true` and a version is detected, this setting is ignored.
      */
     doenetmlVersion?: string;
+    /**
+     * If `true`, look for a xmlns attribute in an outer `<document>` tag
+     * and use that for the doenetmlVersion,
+     * overwriting any doenetmlVersion or urls provided
+     */
+    autodetectVersion?: boolean;
     /**
      * The width of the iframe (and the width of the editor-viewer widget)
      */
@@ -38,7 +47,7 @@ export declare type DoenetEditorIframeProps = DoenetEditorProps & {
     height?: string;
 };
 
-declare type DoenetEditorProps = Omit<default_2.ComponentProps<typeof DoenetEditor_2>, "doenetML" | "width" | "height">;
+declare type DoenetEditorProps = Omit<React.ComponentProps<typeof DoenetEditor_2>, "doenetML" | "width" | "height">;
 
 /**
  * Render Doenet viewer constrained to an iframe. A URL pointing to a version of DoenetML
@@ -49,22 +58,31 @@ declare type DoenetEditorProps = Omit<default_2.ComponentProps<typeof DoenetEdit
  * 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 function DoenetViewer({ doenetML, standaloneUrl: specifiedStandaloneUrl, cssUrl: specifiedCssUrl, doenetmlVersion: specifiedDoenetmlVersion, autodetectVersion, scrollableContainer: _scrollableContainer, ...doenetViewerProps }: DoenetViewerIframeProps): default_2.JSX.Element | null;
 
 export declare type DoenetViewerIframeProps = DoenetViewerProps & {
     doenetML: string;
     /**
      * The URL of a standalone DoenetML bundle. This may be from the CDN.
+     * If autodetectVersion is `true` and a version is detected, this URL is ignored.
      */
     standaloneUrl?: string;
     /**
      * The URL of a CSS file that styles the standalone DoenetML bundle.
+     * If autodetectVersion is `true` and a version is detected, this URL is ignored.
      */
     cssUrl?: string;
     /**
-     * The version of standalone DoenetML bundle if urls are not provided
+     * The version of standalone DoenetML bundle if urls are not provided.
+     * If autodetectVersion is `true` and a version is detected, this setting is ignored.
      */
     doenetmlVersion?: string;
+    /**
+     * If `true`, look for a xmlns attribute in an outer `<document>` tag
+     * and use that for the doenetmlVersion,
+     * 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)
@@ -72,7 +90,7 @@ export declare type DoenetViewerIframeProps = DoenetViewerProps & {
     scrollableContainer?: any;
 };
 
-declare type DoenetViewerProps = Omit<default_2.ComponentProps<typeof DoenetViewer_2>, "doenetML" | "scrollableContainer">;
+declare type DoenetViewerProps = Omit<React.ComponentProps<typeof DoenetViewer_2>, "doenetML" | "scrollableContainer">;
 
 export { mathjaxConfig }