@codecademy/gamut
73.6.273.6.3-alpha.2b3b95.0
dist/Markdown/index.d.ts~
dist/Markdown/index.d.tsModified+13−3
Index: package/dist/Markdown/index.d.ts
===================================================================
--- package/dist/Markdown/index.d.ts
+++ package/dist/Markdown/index.d.ts
@@ -1,14 +1,12 @@
import { PureComponent } from 'react';
import * as React from 'react';
-import { MarkdownOverrideSettings } from './libs/overrides';
+import { MarkdownOverrideSetting, MarkdownOverrideSettings } from './libs/overrides';
export type SkipDefaultOverridesSettings = {
a?: boolean;
checkbox?: boolean;
details?: boolean;
- iframe?: boolean;
table?: boolean;
- video?: boolean;
};
export type MarkdownProps = {
className?: string;
inline?: boolean;
@@ -24,8 +22,20 @@
/**
* Callback when a markdown anchor tag is clicked
*/
onAnchorClick?: (event: React.MouseEvent<HTMLAnchorElement>) => void;
+ /**
+ * Renders <iframe> tags with the given component (e.g. Iframe from
+ * '@codecademy/gamut/Video') instead of a bare iframe. Opt-in so Markdown
+ * doesn't statically depend on react-player unless you need it.
+ */
+ iframeOverride?: MarkdownOverrideSetting;
+ /**
+ * Renders <video> tags with the given component (e.g. MarkdownVideo from
+ * '@codecademy/gamut/Video') instead of a bare video tag. Opt-in so
+ * Markdown doesn't statically depend on react-player unless you need it.
+ */
+ videoOverride?: MarkdownOverrideSetting;
};
export declare class Markdown extends PureComponent<MarkdownProps> {
render(): import("react/jsx-runtime").JSX.Element | null;
}