markstream-react 0.0.20-beta.8 → 0.0.20

package/README.md

@@ -12,6 +12,8 @@ pnpm --filter markstream-react dev
 
 ```bash
 pnpm --filter markstream-react build
+pnpm --filter markstream-react build:analyze
+pnpm --filter markstream-react size:check
 ```
 
 ## Usage
@@ -29,6 +31,19 @@ export default function Article({ markdown }: { markdown: string }) {
 
 You can also pass a pre-parsed `nodes` array if you already have AST data.
 
+## Bundle size notes
+
+- Optional peers are not bundled; install only what you use (`stream-monaco`, `stream-markdown`, `mermaid`, `katex`, etc.).
+- Infrequent language icons are split into an async chunk and loaded on demand.
+- To avoid first-hit fallback icons, preload once when the app is idle:
+
+```tsx
+import { preloadExtendedLanguageIcons } from 'markstream-react'
+
+if (typeof window !== 'undefined')
+  void preloadExtendedLanguageIcons()
+```
+
 ## Tailwind
 
 - Non-Tailwind projects: keep importing `markstream-react/index.css` (includes precompiled utilities for the renderer).

package/dist/index.d.ts

@@ -28,6 +28,7 @@ interface NodeRendererProps {
     codeBlockMinWidth?: string | number;
     codeBlockMaxWidth?: string | number;
     codeBlockProps?: Record<string, any>;
+    showTooltips?: boolean;
     themes?: string[];
     isDark?: boolean;
     customId?: string;
@@ -55,6 +56,7 @@ interface RenderContext {
     typewriter?: boolean;
     customComponents?: Record<string, React.ComponentType<any>>;
     codeBlockProps?: Record<string, any>;
+    showTooltips?: boolean;
     codeBlockStream?: boolean;
     renderCodeBlocksAsPre?: boolean;
     codeBlockThemes?: {
@@ -122,6 +124,7 @@ interface CodeBlockNodeProps {
     showExpandButton?: boolean;
     showPreviewButton?: boolean;
     showFontSizeButtons?: boolean;
+    showTooltips?: boolean;
     customId?: string;
 }
 interface ImageNodeProps {
@@ -258,6 +261,14 @@ interface HtmlPreviewFrameProps {
 }
 declare function HtmlPreviewFrame(props: HtmlPreviewFrameProps): React.ReactPortal;
 
+type D2Loader = () => Promise<any> | any;
+declare function setD2Loader(loader: D2Loader | null): void;
+declare function enableD2(loader?: D2Loader): void;
+declare function disableD2(): void;
+declare function isD2Enabled(): boolean;
+
+declare function D2BlockNode(rawProps: D2BlockNodeProps): react_jsx_runtime.JSX.Element;
+
 declare function DefinitionListNode(props: NodeComponentProps<{
     type: 'definition_list';
     items?: any[];
@@ -328,8 +339,6 @@ interface ImageNodeReactEvents {
 }
 declare function ImageNode(rawProps: ImageNodeProps & ImageNodeReactEvents): react_jsx_runtime.JSX.Element;
 
-declare function D2BlockNode(rawProps: D2BlockNodeProps): react_jsx_runtime.JSX.Element;
-
 interface InfographicBlockNodeReactEvents {
     onCopy?: (code: string) => void;
     onExport?: (event: MermaidBlockEvent<{
@@ -415,6 +424,7 @@ interface MarkdownCodeBlockNodeProps {
     showExpandButton?: boolean;
     showPreviewButton?: boolean;
     showFontSizeButtons?: boolean;
+    showTooltips?: boolean;
     onCopy?: (code: string) => void;
     onPreviewCode?: (payload: {
         type: string;
@@ -540,16 +550,12 @@ declare function useSafeI18n(): {
 
 declare function renderNode(node: ParsedNode, key: React.Key, ctx: RenderContext): react_jsx_runtime.JSX.Element;
 
-type D2Loader = () => Promise<any> | any;
-declare function setD2Loader(loader: D2Loader | null): void;
-declare function enableD2(loader?: D2Loader): void;
-declare function disableD2(): void;
-declare function isD2Enabled(): boolean;
-
 type LanguageIconResolver = (lang: string) => string | undefined | null;
 declare function setLanguageIconResolver(resolver?: LanguageIconResolver | null): void;
 declare function normalizeLanguageIdentifier(lang?: string | null): string;
 declare function resolveMonacoLanguageId(lang?: string | null): string;
+declare function preloadExtendedLanguageIcons(): Promise<void>;
+declare function subscribeLanguageIconsRevision(listener: () => void): () => void;
 declare function getLanguageIcon(lang: string): string;
 declare const languageMap: Record<string, string>;
 
@@ -598,4 +604,4 @@ declare function canParseOffthread(code: string, theme: Theme, timeout?: number)
 declare function findPrefixOffthread(code: string, theme: Theme, timeout?: number): Promise<string>;
 declare function terminateWorker(): void;
 
-export { AdmonitionNode, BackpressureOptions, BlockquoteNode, CheckboxNode, CodeBlockNode, CodeBlockNodeProps, D2BlockNode, D2BlockNodeProps, D2Loader, DefinitionListNode, EmojiNode, EmphasisNode, FallbackComponent, FootnoteAnchorNode, FootnoteNode, FootnoteReferenceNode, HardBreakNode, HeadingNode, HighlightNode, HtmlBlockNode, HtmlInlineNode, HtmlPreviewFrame, ImageNode, ImageNodeProps, InfographicBlockNode, InfographicBlockNodeProps, InlineCodeNode, InsertNode, LanguageIconResolver, LinkNode, LinkNodeProps, ListItemNode, ListNode, MERMAID_WORKER_BUSY_CODE, MarkdownCodeBlockNode, MathBlockNode, MathBlockNodeProps, MathInlineNode, MathInlineNodeProps, MermaidBlockEvent, MermaidBlockNode, MermaidBlockNodeProps, NodeComponentProps, NodeRenderer, NodeRendererProps, ParagraphNode, PreCodeNode, PreCodeNodeProps, CodeBlockNode as ReactCodeBlockNode, ReferenceNode, StrikethroughNode, StrongNode, SubscriptNode, SuperscriptNode, TableNode, TextNode, ThematicBreakNode, Tooltip, VmrContainerNode, WORKER_BUSY_CODE, canParseOffthread, clearGlobalCustomComponents, clearKaTeXCache, clearKaTeXWorker, clearMermaidWorker, NodeRenderer as default, disableD2, enableD2, findPrefixOffthread, getCustomNodeComponents, getKaTeXBackpressureDefaults, getLanguageIcon, getMermaidWorkerLoad, isD2Enabled, languageMap, normalizeLanguageIdentifier, removeCustomComponents, renderKaTeXInWorker, renderKaTeXWithBackpressure, renderNode, resolveMonacoLanguageId, setCustomComponents, setD2Loader, setDefaultI18nMap, setKaTeXBackpressureDefaults, setKaTeXCache, setKaTeXConcurrencyLimit, setKaTeXWorker, setKaTeXWorkerDebug, setLanguageIconResolver, setMermaidWorker, setMermaidWorkerClientDebug, setMermaidWorkerMaxConcurrency, terminateWorker, useSafeI18n, waitForKaTeXWorkerSlot };
+export { AdmonitionNode, BackpressureOptions, BlockquoteNode, CheckboxNode, CodeBlockNode, CodeBlockNodeProps, D2BlockNode, D2BlockNodeProps, D2Loader, DefinitionListNode, EmojiNode, EmphasisNode, FallbackComponent, FootnoteAnchorNode, FootnoteNode, FootnoteReferenceNode, HardBreakNode, HeadingNode, HighlightNode, HtmlBlockNode, HtmlInlineNode, HtmlPreviewFrame, ImageNode, ImageNodeProps, InfographicBlockNode, InfographicBlockNodeProps, InlineCodeNode, InsertNode, LanguageIconResolver, LinkNode, LinkNodeProps, ListItemNode, ListNode, MERMAID_WORKER_BUSY_CODE, MarkdownCodeBlockNode, MathBlockNode, MathBlockNodeProps, MathInlineNode, MathInlineNodeProps, MermaidBlockEvent, MermaidBlockNode, MermaidBlockNodeProps, NodeComponentProps, NodeRenderer, NodeRendererProps, ParagraphNode, PreCodeNode, PreCodeNodeProps, CodeBlockNode as ReactCodeBlockNode, ReferenceNode, StrikethroughNode, StrongNode, SubscriptNode, SuperscriptNode, TableNode, TextNode, ThematicBreakNode, Tooltip, VmrContainerNode, WORKER_BUSY_CODE, canParseOffthread, clearGlobalCustomComponents, clearKaTeXCache, clearKaTeXWorker, clearMermaidWorker, NodeRenderer as default, disableD2, enableD2, findPrefixOffthread, getCustomNodeComponents, getKaTeXBackpressureDefaults, getLanguageIcon, getMermaidWorkerLoad, isD2Enabled, languageMap, normalizeLanguageIdentifier, preloadExtendedLanguageIcons, removeCustomComponents, renderKaTeXInWorker, renderKaTeXWithBackpressure, renderNode, resolveMonacoLanguageId, setCustomComponents, setD2Loader, setDefaultI18nMap, setKaTeXBackpressureDefaults, setKaTeXCache, setKaTeXConcurrencyLimit, setKaTeXWorker, setKaTeXWorkerDebug, setLanguageIconResolver, setMermaidWorker, setMermaidWorkerClientDebug, setMermaidWorkerMaxConcurrency, subscribeLanguageIconsRevision, terminateWorker, useSafeI18n, waitForKaTeXWorkerSlot };