@incremark/vue 0.2.5 → 0.2.7

package/dist/components/Incremark.vue.d.ts

@@ -2,19 +2,37 @@ import { type Component } from 'vue';
 import type { ParsedBlock } from '@incremark/core';
 import type { UseIncremarkReturn } from '../composables/useIncremark';
 export type ComponentMap = Partial<Record<string, Component>>;
-export interface BlockWithStableId extends ParsedBlock {
-    stableId: string;
+export type RenderableBlock = ParsedBlock & {
     isLastPending?: boolean;
+};
+/**
+ * 代码块配置
+ */
+export interface CodeBlockConfig {
+    /** 是否从一开始就接管渲染，而不是等到 completed 状态 */
+    takeOver?: boolean;
+}
+/**
+ * 代码块配置
+ */
+export interface CodeBlockConfig {
+    /** 是否从一开始就接管渲染，而不是等到 completed 状态 */
+    takeOver?: boolean;
 }
 type __VLS_Props = {
     /** 要渲染的块列表（来自 useIncremark 的 blocks） */
-    blocks?: BlockWithStableId[];
+    blocks?: RenderableBlock[];
+    /** 内容是否完全显示完成（用于控制脚注等需要在内容完全显示后才出现的元素）
+     * 如果传入了 incremark，则会自动使用 incremark.isDisplayComplete，此 prop 被忽略 */
+    isDisplayComplete?: boolean;
     /** 自定义组件映射，key 为节点类型 */
     components?: ComponentMap;
     /** 自定义容器组件映射，key 为容器名称（如 'warning', 'info'） */
     customContainers?: Record<string, Component>;
     /** 自定义代码块组件映射，key 为代码语言名称（如 'echart', 'mermaid'） */
     customCodeBlocks?: Record<string, Component>;
+    /** 代码块配置映射，key 为代码语言名称 */
+    codeBlockConfigs?: Record<string, CodeBlockConfig>;
     /** 待处理块的样式类名 */
     pendingClass?: string;
     /** 已完成块的样式类名 */
@@ -25,8 +43,10 @@ type __VLS_Props = {
     incremark?: UseIncremarkReturn;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
-    blocks: BlockWithStableId[];
+    blocks: RenderableBlock[];
+    isDisplayComplete: boolean;
     customCodeBlocks: Record<string, Component>;
+    codeBlockConfigs: Record<string, CodeBlockConfig>;
     customContainers: Record<string, Component>;
     components: Partial<Record<string, Component>>;
     pendingClass: string;

package/dist/components/IncremarkCode.vue.d.ts

@@ -1,23 +1,30 @@
 import type { Code } from 'mdast';
 import type { Component } from 'vue';
+import type { CodeBlockConfig } from './Incremark.vue';
 type __VLS_Props = {
     node: Code;
     /** Shiki 主题，默认 github-dark */
     theme?: string;
+    /** 默认回退主题（当指定主题加载失败时使用），默认 github-dark */
+    fallbackTheme?: string;
     /** 是否禁用代码高亮 */
     disableHighlight?: boolean;
     /** Mermaid 渲染延迟（毫秒），用于流式输入时防抖 */
     mermaidDelay?: number;
     /** 自定义代码块组件映射，key 为代码语言名称 */
     customCodeBlocks?: Record<string, Component>;
+    /** 代码块配置映射，key 为代码语言名称 */
+    codeBlockConfigs?: Record<string, CodeBlockConfig>;
     /** 块状态，用于判断是否使用自定义组件 */
     blockStatus?: 'pending' | 'stable' | 'completed';
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
     theme: string;
+    fallbackTheme: string;
     disableHighlight: boolean;
     mermaidDelay: number;
     customCodeBlocks: Record<string, Component>;
+    codeBlockConfigs: Record<string, CodeBlockConfig>;
     blockStatus: "pending" | "stable" | "completed";
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/components/IncremarkContent.vue.d.ts

@@ -0,0 +1,3 @@
+import { IncremarkContentProps } from '../types';
+declare const _default: import("vue").DefineComponent<IncremarkContentProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<IncremarkContentProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/IncremarkRenderer.vue.d.ts

@@ -1,12 +1,15 @@
 import type { RootContent } from 'mdast';
 import type { Component } from 'vue';
 import type { ContainerNode } from './IncremarkContainer.vue';
+import type { CodeBlockConfig } from './Incremark.vue';
 type ExtendedRootContent = RootContent | ContainerNode;
 type __VLS_Props = {
     node: ExtendedRootContent;
     customContainers?: Record<string, Component>;
     customCodeBlocks?: Record<string, Component>;
+    codeBlockConfigs?: Record<string, CodeBlockConfig>;
     blockStatus?: 'pending' | 'stable' | 'completed';
+    components?: Partial<Record<string, Component>>;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/components/index.d.ts

@@ -1,5 +1,7 @@
+export type { IncremarkContentProps } from '../types';
 export { default as Incremark } from './Incremark.vue';
-export type { ComponentMap, BlockWithStableId } from './Incremark.vue';
+export { default as IncremarkContent } from '../components/IncremarkContent.vue';
+export type { ComponentMap, RenderableBlock } from './Incremark.vue';
 export { default as IncremarkRenderer } from './IncremarkRenderer.vue';
 export { default as IncremarkHeading } from './IncremarkHeading.vue';
 export { default as IncremarkParagraph } from './IncremarkParagraph.vue';

package/dist/composables/useIncremark.d.ts

@@ -1,4 +1,4 @@
-import { type ComputedRef } from 'vue';
+import { type ComputedRef, type MaybeRefOrGetter } from 'vue';
 import { type ParserOptions, type ParsedBlock, type IncrementalUpdate, type Root, type TransformerPlugin, type AnimationEffect } from '@incremark/core';
 /** 打字机效果配置 */
 export interface TypewriterOptions {
@@ -76,7 +76,7 @@ export type UseIncremarkReturn = ReturnType<typeof useIncremark>;
  * </template>
  * ```
  */
-export declare function useIncremark(options?: UseIncremarkOptions): {
+export declare function useIncremark(optionsInput?: MaybeRefOrGetter<UseIncremarkOptions>): {
     /** 已收集的完整 Markdown 字符串 */
     markdown: import("vue").Ref<string, string>;
     /** 已完成的块列表 */
@@ -87,7 +87,7 @@ export declare function useIncremark(options?: UseIncremarkOptions): {
     ast: ComputedRef<Root>;
     /** 用于渲染的 blocks（根据打字机设置自动处理） */
     blocks: ComputedRef<(ParsedBlock & {
-        stableId: string;
+        isLastPending?: boolean;
     })[]>;
     /** 是否正在加载 */
     isLoading: import("vue").Ref<boolean, boolean>;

package/dist/composables/useShiki.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Shiki Highlighter 单例管理器
+ *
+ * 避免重复创建 Shiki 实例，所有组件共享同一个 highlighter
+ */
+import type { HighlighterGeneric, BundledLanguage, BundledTheme } from 'shiki';
+interface HighlighterInfo {
+    highlighter: HighlighterGeneric<BundledLanguage, BundledTheme>;
+    loadedLanguages: Set<BundledLanguage>;
+    loadedThemes: Set<BundledTheme>;
+}
+/** Shiki highlighter 单例管理器 */
+declare class ShikiManager {
+    private static instance;
+    /** 存储 highlighter 实例，key 为主题名称 */
+    private highlighters;
+    private constructor();
+    static getInstance(): ShikiManager;
+    /**
+     * 获取或创建 highlighter
+     * @param theme 主题名称
+     * @returns highlighter 实例
+     */
+    getHighlighter(theme: BundledTheme): Promise<HighlighterInfo>;
+    /**
+     * 加载语言（按需）
+     * @param theme 主题名称
+     * @param lang 语言名称
+     */
+    loadLanguage(theme: BundledTheme, lang: BundledLanguage): Promise<void>;
+    /**
+     * 加载主题（按需）
+     * @param theme 主题名称
+     */
+    loadTheme(theme: BundledTheme): Promise<void>;
+    /**
+     * 高亮代码
+     * @param theme 主题名称
+     * @param code 代码内容
+     * @param lang 语言名称
+     * @param fallbackTheme 回退主题
+     * @returns 高亮后的 HTML
+     */
+    codeToHtml(theme: BundledTheme, code: string, lang: BundledLanguage, fallbackTheme: BundledTheme): Promise<string>;
+    /**
+     * 清理所有 highlighter（应用退出或需要重置时调用）
+     */
+    disposeAll(): void;
+}
+declare const shikiManager: ShikiManager;
+export { shikiManager, ShikiManager };
+/**
+ * 使用 Shiki Highlighter（组合式函数）
+ *
+ * @param theme 主题名称
+ * @returns Shiki 相关的响应式状态和方法
+ */
+export declare function useShiki(theme: string): {
+    highlighterInfo: import("vue").ShallowRef<HighlighterInfo | null, HighlighterInfo | null>;
+    isHighlighting: import("vue").ShallowRef<boolean, boolean>;
+    highlight: (code: string, lang: string, fallbackTheme: string) => Promise<string>;
+};

package/dist/composables/useStreamRenderer.d.ts

@@ -1,9 +1,5 @@
 import { type Ref, type ComputedRef } from 'vue';
 import type { ParsedBlock } from '@incremark/core';
-export interface BlockWithStableId extends ParsedBlock {
-    /** 稳定的渲染 ID（用于 Vue key） */
-    stableId: string;
-}
 export interface UseStreamRendererOptions {
     /** 已完成的块 */
     completedBlocks: Ref<ParsedBlock[]>;
@@ -11,16 +7,16 @@ export interface UseStreamRendererOptions {
     pendingBlocks: Ref<ParsedBlock[]>;
 }
 export interface UseStreamRendererReturn {
-    /** 带稳定 ID 的已完成块 */
-    stableCompletedBlocks: ComputedRef<BlockWithStableId[]>;
-    /** 带稳定 ID 的待处理块 */
-    stablePendingBlocks: ComputedRef<BlockWithStableId[]>;
-    /** 所有带稳定 ID 的块 */
-    allStableBlocks: ComputedRef<BlockWithStableId[]>;
+    /** 已完成的块 */
+    completedBlocks: ComputedRef<ParsedBlock[]>;
+    /** 待处理的块 */
+    pendingBlocks: ComputedRef<ParsedBlock[]>;
+    /** 所有块 */
+    allBlocks: ComputedRef<ParsedBlock[]>;
 }
 /**
  * Vue 3 Composable: 流式渲染辅助
  *
- * 为块分配稳定的渲染 ID，确保 Vue 的虚拟 DOM 复用
+ * 直接使用 block.id 作为稳定的渲染 key
  */
 export declare function useStreamRenderer(options: UseStreamRendererOptions): UseStreamRendererReturn;

package/dist/composables/useTypewriter.d.ts

@@ -7,18 +7,18 @@
  * @author Incremark Team
  * @license MIT
  */
-import { type Ref, type ComputedRef } from 'vue';
+import { type Ref, type ComputedRef, type MaybeRefOrGetter } from 'vue';
 import { type RootContent, type ParsedBlock, type BlockTransformer } from '@incremark/core';
 import type { TypewriterOptions, TypewriterControls } from './useIncremark';
 export interface UseTypewriterOptions {
-    typewriter?: TypewriterOptions;
+    typewriter: MaybeRefOrGetter<TypewriterOptions | undefined>;
     completedBlocks: Ref<ParsedBlock[]>;
     pendingBlocks: Ref<ParsedBlock[]>;
 }
 export interface UseTypewriterReturn {
     /** 用于渲染的 blocks（经过打字机处理或原始blocks） */
     blocks: ComputedRef<Array<ParsedBlock & {
-        stableId: string;
+        isLastPending?: boolean;
     }>>;
     /** 打字机控制对象 */
     typewriter: TypewriterControls;

package/dist/index.d.ts

@@ -2,8 +2,7 @@ export { useIncremark, useStreamRenderer, useDevTools, useBlockTransformer } fro
 export { useProvideDefinations } from './composables/useProvideDefinations';
 export { useDefinationsContext } from './composables/useDefinationsContext';
 export type { UseIncremarkOptions, TypewriterOptions, TypewriterControls, UseStreamRendererOptions, UseDevToolsOptions, UseBlockTransformerOptions, UseBlockTransformerReturn } from './composables';
-export { Incremark, IncremarkRenderer, IncremarkHeading, IncremarkParagraph, IncremarkCode, IncremarkList, IncremarkTable, IncremarkBlockquote, IncremarkThematicBreak, IncremarkInline, IncremarkMath, IncremarkHtmlElement, IncremarkDefault, IncremarkFootnotes, AutoScrollContainer } from './components';
-export type { ComponentMap, BlockWithStableId } from './components';
+export * from './components';
 export { default as ThemeProvider } from './ThemeProvider.vue';
 export type { ParsedBlock, IncrementalUpdate, ParserOptions, BlockStatus, Root, RootContent, SourceBlock, DisplayBlock, TransformerPlugin, TransformerOptions, TransformerState, AnimationEffect } from '@incremark/core';
 export { BlockTransformer, createBlockTransformer, countChars, sliceAst, cloneNode, codeBlockPlugin, mermaidPlugin, imagePlugin, mathPlugin, thematicBreakPlugin, defaultPlugins, allPlugins, createPlugin } from '@incremark/core';