markview-vue 0.1.9 → 0.1.13

package/dist/index.d.ts

@@ -5,7 +5,6 @@ import { FunctionalComponent } from 'vue';
 import { HighlighterCore } from 'shiki/core';
 import { InjectionKey } from 'vue';
 import { LucideProps } from 'lucide-vue-next';
-import { MDXComponents } from 'mdx/types';
 import { MDXProps } from 'mdx/types';
 import { PluggableList } from '@mdx-js/mdx/lib/core';
 import { Plugin as Plugin_2 } from 'vue';
@@ -49,9 +48,9 @@ declare const __VLS_component_14: DefineComponent<Props, {}, {}, {}, {}, Compone
     title: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
 
-declare const __VLS_component_15: DefineComponent<__VLS_Props_12, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_15: DefineComponent<__VLS_Props_14, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     motionEnd: () => any;
-}, string, PublicProps, Readonly<__VLS_Props_12> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_14> & Readonly<{
     onMotionEnd?: (() => any) | undefined;
 }>, {
     duration: number;
@@ -62,11 +61,11 @@ declare const __VLS_component_15: DefineComponent<__VLS_Props_12, {}, {}, {}, {}
     contentRef: HTMLDivElement;
 }, HTMLDivElement>;
 
-declare const __VLS_component_16: DefineComponent<__VLS_Props_13, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_16: DefineComponent<__VLS_Props_15, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     change: (expanded: boolean) => any;
     motionEnd: () => any;
     "update:expanded": (value: boolean) => any;
-}, string, PublicProps, Readonly<__VLS_Props_13> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_15> & Readonly<{
     onChange?: ((expanded: boolean) => any) | undefined;
     onMotionEnd?: (() => any) | undefined;
     "onUpdate:expanded"?: ((value: boolean) => any) | undefined;
@@ -80,7 +79,7 @@ declare const __VLS_component_16: DefineComponent<__VLS_Props_13, {}, {}, {}, {}
     expandText: string;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
 
-declare const __VLS_component_17: DefineComponent<__VLS_Props_15, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_15> & Readonly<{}>, {
+declare const __VLS_component_17: DefineComponent<__VLS_Props_17, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_17> & Readonly<{}>, {
     disabled: boolean;
     position: TooltipPosition;
     trigger: "hover" | "focus" | "both";
@@ -93,10 +92,10 @@ declare const __VLS_component_17: DefineComponent<__VLS_Props_15, {}, {}, {}, {}
     tooltipRef: HTMLDivElement;
 }, any>;
 
-declare const __VLS_component_18: DefineComponent<__VLS_Props_17, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_18: DefineComponent<__VLS_Props_19, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     change: (checked: boolean) => any;
     "update:modelValue": (value: boolean) => any;
-}, string, PublicProps, Readonly<__VLS_Props_17> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_19> & Readonly<{
     onChange?: ((checked: boolean) => any) | undefined;
     "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
 }>, {
@@ -105,10 +104,10 @@ declare const __VLS_component_18: DefineComponent<__VLS_Props_17, {}, {}, {}, {}
     indeterminate: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLSpanElement>;
 
-declare const __VLS_component_19: DefineComponent<__VLS_Props_18, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+declare const __VLS_component_19: DefineComponent<__VLS_Props_20, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     close: () => any;
     click: (e: MouseEvent) => any;
-}, string, PublicProps, Readonly<__VLS_Props_18> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_20> & Readonly<{
     onClose?: (() => any) | undefined;
     onClick?: ((e: MouseEvent) => any) | undefined;
 }>, {
@@ -120,7 +119,7 @@ declare const __VLS_component_19: DefineComponent<__VLS_Props_18, {}, {}, {}, {}
 
 declare const __VLS_component_2: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
-declare const __VLS_component_20: DefineComponent<__VLS_Props_19, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_19> & Readonly<{}>, {
+declare const __VLS_component_20: DefineComponent<__VLS_Props_21, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_21> & Readonly<{}>, {
     layout: "horizontal" | "vertical";
     dashed: boolean;
     align: "left" | "center" | "right";
@@ -148,6 +147,17 @@ declare type __VLS_Props = {
 };
 
 declare type __VLS_Props_10 = {
+    items: TocItem_2[];
+    activeId?: string;
+    minLevel?: number;
+    maxLevel?: number;
+};
+
+declare type __VLS_Props_11 = {
+    active?: boolean;
+};
+
+declare type __VLS_Props_12 = {
     src?: string;
     alt?: string;
     width?: string | number;
@@ -155,20 +165,20 @@ declare type __VLS_Props_10 = {
     fit?: 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
 };
 
-declare type __VLS_Props_11 = {
+declare type __VLS_Props_13 = {
     visible: boolean;
     src: string;
     title?: string;
 };
 
-declare type __VLS_Props_12 = {
+declare type __VLS_Props_14 = {
     isOpen?: boolean;
     duration?: number;
     keepDOM?: boolean;
     collapseHeight?: number;
 };
 
-declare type __VLS_Props_13 = {
+declare type __VLS_Props_15 = {
     title?: string;
     defaultExpanded?: boolean;
     expanded?: boolean;
@@ -180,13 +190,13 @@ declare type __VLS_Props_13 = {
     expandText?: string;
 };
 
-declare type __VLS_Props_14 = {
+declare type __VLS_Props_16 = {
     name: IconName;
     size?: number;
     strokeWidth?: number;
 };
 
-declare type __VLS_Props_15 = {
+declare type __VLS_Props_17 = {
     content: string;
     position?: TooltipPosition;
     trigger?: 'hover' | 'focus' | 'both';
@@ -197,36 +207,36 @@ declare type __VLS_Props_15 = {
     disabled?: boolean;
 };
 
-declare type __VLS_Props_16 = {
+declare type __VLS_Props_18 = {
     href: string;
     alwaysVisible?: boolean;
 };
 
-declare type __VLS_Props_17 = {
+declare type __VLS_Props_19 = {
     modelValue?: boolean;
     disabled?: boolean;
     indeterminate?: boolean;
 };
 
-declare type __VLS_Props_18 = {
+declare type __VLS_Props_2 = {
+    src?: string;
+    alt?: string;
+};
+
+declare type __VLS_Props_20 = {
     size?: TagSize;
     type?: TagType;
     color?: TagColor;
     closable?: boolean;
 };
 
-declare type __VLS_Props_19 = {
+declare type __VLS_Props_21 = {
     layout?: 'horizontal' | 'vertical';
     dashed?: boolean;
     align?: 'left' | 'center' | 'right';
     margin?: string | number;
 };
 
-declare type __VLS_Props_2 = {
-    src?: string;
-    alt?: string;
-};
-
 declare type __VLS_Props_3 = {
     dashed?: boolean;
 };
@@ -261,7 +271,7 @@ declare type __VLS_Props_8 = {
 };
 
 declare type __VLS_Props_9 = {
-    active?: boolean;
+    code: string;
 };
 
 declare function __VLS_template(): {
@@ -612,7 +622,7 @@ declare type __VLS_WithTemplateSlots_9<T, S> = T & {
 
 export declare const a: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 
-export declare const Anchor: DefineComponent<__VLS_Props_16, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_16> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLSpanElement>;
+export declare const Anchor: DefineComponent<__VLS_Props_18, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_18> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLSpanElement>;
 
 export declare const BlockHeader: __VLS_WithTemplateSlots_11<typeof __VLS_component_11, __VLS_TemplateResult_11["slots"]>;
 
@@ -630,7 +640,7 @@ export declare const CodeBlock: DefineComponent<__VLS_Props_4, {}, {}, {}, {}, C
     maxLines: number;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {
     bodyRef: HTMLDivElement;
-}, HTMLDivElement>;
+}, any>;
 
 export declare const CollapseSection: __VLS_WithTemplateSlots_16<typeof __VLS_component_16, __VLS_TemplateResult_16["slots"]>;
 
@@ -673,6 +683,32 @@ declare type ContainerType_2 = 'tip' | 'warning' | 'danger' | 'info';
  */
 export declare function copyToClipboard(text: string): Promise<boolean>;
 
+/**
+ * 创建 Highlighter Vue Plugin
+ *
+ * 在应用初始化时预加载语言，后续所有 MarkdownRender 实例自动可用。
+ *
+ * @example
+ * ```ts
+ * import { createHighlighterPlugin } from 'markview-vue'
+ *
+ * // 方式 1：传入多个语言
+ * app.use(createHighlighterPlugin({
+ *   langs: [
+ *     import('@shikijs/langs/python'),
+ *     import('@shikijs/langs/rust'),
+ *     import('@shikijs/langs/go'),
+ *   ]
+ * }))
+ *
+ * // 方式 2：传入整个语言包
+ * app.use(createHighlighterPlugin({
+ *   langs: import('@shikijs/langs')
+ * }))
+ * ```
+ */
+export declare function createHighlighterPlugin(options?: HighlighterPluginOptions): Plugin_2;
+
 declare const _default: __VLS_WithTemplateSlots_4<typeof __VLS_component_4, __VLS_TemplateResult_4["slots"]>;
 export { _default as ListItem }
 export { _default as li }
@@ -701,6 +737,11 @@ export { _default_6 as mark }
 
 export declare const Divider: __VLS_WithTemplateSlots_20<typeof __VLS_component_20, __VLS_TemplateResult_20["slots"]>;
 
+/**
+ * 确保 highlighter 已初始化
+ */
+declare function ensureReady(): Promise<void>;
+
 /**
  * 从 VNode 中提取语言标识（用于代码块）
  */
@@ -764,10 +805,19 @@ declare function hide(): void;
 
 /**
  * 高亮代码
+ *
+ * @param code - 源代码
+ * @param lang - 语言标识
+ * @param theme - 主题名称，'light' | 'dark'，默认 'light'
  */
-export declare function highlightCode(code: string, lang: string): Promise<string>;
+export declare function highlightCode(code: string, lang: string, theme?: 'light' | 'dark'): Promise<string>;
+
+export declare interface HighlighterPluginOptions {
+    /** 需要预加载的语言包 */
+    langs?: LangInput;
+}
 
-export declare const Icon: DefineComponent<__VLS_Props_14, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_14> & Readonly<{}>, {
+export declare const Icon: DefineComponent<__VLS_Props_16, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_16> & Readonly<{}>, {
     size: number;
     strokeWidth: number;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
@@ -800,6 +850,8 @@ declare const iconMap: {
     readonly info: FunctionalComponent<LucideProps, {}, any, {}>;
     readonly lightbulb: FunctionalComponent<LucideProps, {}, any, {}>;
     readonly code: FunctionalComponent<LucideProps, {}, any, {}>;
+    readonly 'code-2': FunctionalComponent<LucideProps, {}, any, {}>;
+    readonly eye: FunctionalComponent<LucideProps, {}, any, {}>;
     readonly table: FunctionalComponent<LucideProps, {}, any, {}>;
     readonly quote: FunctionalComponent<LucideProps, {}, any, {}>;
     readonly image: FunctionalComponent<LucideProps, {}, any, {}>;
@@ -808,19 +860,26 @@ declare const iconMap: {
 
 export declare type IconName = keyof typeof iconMap;
 
-declare const Image_2: DefineComponent<__VLS_Props_10, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_10> & Readonly<{}>, {
+declare const Image_2: DefineComponent<__VLS_Props_12, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_12> & Readonly<{}>, {
     fit: "fill" | "contain" | "cover" | "none" | "scale-down";
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
 export { Image_2 as Image }
 
-export declare const ImagePreview: DefineComponent<__VLS_Props_11, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+export declare const ImagePreview: DefineComponent<__VLS_Props_13, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     close: () => any;
-}, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{
+}, string, PublicProps, Readonly<__VLS_Props_13> & Readonly<{
     onClose?: (() => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
 export declare const img: DefineComponent<__VLS_Props_2, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_2> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLElement>;
 
+declare const isLoading: Ref<boolean, boolean>;
+
+declare const isReady: Ref<boolean, boolean>;
+
+/** 支持的语言包输入类型 */
+export declare type LangInput = Promise<any>[] | Promise<any>;
+
 /**
  * 语言别名映射表
  */
@@ -828,6 +887,40 @@ export declare const LANGUAGE_ALIASES: Record<string, string>;
 
 export declare const List: __VLS_WithTemplateSlots_13<typeof __VLS_component_13, __VLS_TemplateResult_13["slots"]>;
 
+declare const loadedLangs: Ref<string[], string[]>;
+
+/**
+ * 加载额外语言
+ *
+ * @param langs - 支持单个 Promise、Promise 数组、或整个语言包
+ */
+declare function loadLangs(langs: LangInput): Promise<void>;
+
+/**
+ * 动态加载额外语言
+ *
+ * @param langs - 语言包输入，支持以下格式：
+ *   - 单个语言 Promise：`import('@shikijs/langs/python')`
+ *   - 语言 Promise 数组：`[import('@shikijs/langs/python'), import('@shikijs/langs/rust')]`
+ *   - 语言包 Promise：`import('@shikijs/langs')` — 自动解析包内所有语言
+ *
+ * @example
+ * ```ts
+ * // 方式1：传入单个语言
+ * await loadLanguages(import('@shikijs/langs/python'))
+ *
+ * // 方式2：传入多个语言
+ * await loadLanguages([
+ *   import('@shikijs/langs/python'),
+ *   import('@shikijs/langs/rust'),
+ * ])
+ *
+ * // 方式3：传入整个语言包（会自动解析所有语言）
+ * await loadLanguages(import('@shikijs/langs'))
+ * ```
+ */
+export declare function loadLanguages(langs: LangInput): Promise<void>;
+
 export declare const MarkdownRender: DefineComponent<MarkdownRenderProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     error: (error: Error) => any;
     rendered: () => any;
@@ -843,7 +936,7 @@ export declare const MarkdownRender: DefineComponent<MarkdownRenderProps, {}, {}
 }>, {
     format: "md" | "mdx";
     theme: "light" | "dark";
-    components: MDXComponents;
+    components: MDXProps["components"];
     raw: string;
     remarkGfm: boolean;
     prefix: string;
@@ -853,6 +946,7 @@ export declare const MarkdownRender: DefineComponent<MarkdownRenderProps, {}, {}
     tocMode: "sidebar" | "embedded";
     showBackTop: boolean;
     backTopThreshold: number;
+    extraLangs: LangInput;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {
     wrapperRef: HTMLDivElement;
     contentRef: HTMLDivElement;
@@ -899,8 +993,19 @@ export declare interface MarkdownRenderProps {
     showBackTop?: boolean;
     /** 回到顶部按钮显示阈值（滚动距离） */
     backTopThreshold?: number;
+    /**
+     * 额外语言包，支持以下格式：
+     * - 单个语言：import('@shikijs/langs/python')
+     * - 语言数组：[import('@shikijs/langs/python'), import('@shikijs/langs/rust')]
+     * - 语言包（bundled）：import('@shikijs/langs') — 自动解析包内所有语言
+     */
+    extraLangs?: LangInput;
 }
 
+export declare const Mermaid: DefineComponent<__VLS_Props_9, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_9> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
+    containerRef: HTMLDivElement;
+}, HTMLDivElement>;
+
 /**
  * 规范化语言标识
  */
@@ -937,9 +1042,12 @@ declare interface Props {
  */
 export declare function provideHeadingCollapse(): HeadingCollapseState;
 
+/** 刷新已加载语言列表 */
+declare function refreshLoadedLangs(): Promise<void>;
+
 declare function show(msg: string, toastType?: ToastType_2, duration?: number): void;
 
-export declare const Skeleton: DefineComponent<__VLS_Props_9, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_9> & Readonly<{}>, {
+export declare const Skeleton: DefineComponent<__VLS_Props_11, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props_11> & Readonly<{}>, {
     active: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, HTMLDivElement>;
 
@@ -996,6 +1104,15 @@ declare interface TocItem_2 {
     id: string;
 }
 
+export declare const TocMobile: DefineComponent<__VLS_Props_10, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    click: (item: TocItem_2) => any;
+}, string, PublicProps, Readonly<__VLS_Props_10> & Readonly<{
+    onClick?: ((item: TocItem_2) => any) | undefined;
+}>, {
+    minLevel: number;
+    maxLevel: number;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
 export declare interface TocProps {
     /** 目录项列表 */
     items: TocItem_2[];
@@ -1036,6 +1153,36 @@ export declare const ul: DefineComponent<{}, () => VNode<RendererNode, RendererE
  */
 export declare function useHeadingCollapse(): HeadingCollapseState | null;
 
+/**
+ * Composable：在组件内使用 highlighter
+ *
+ * @example
+ * ```ts
+ * const { loadLangs, loadedLangs, isReady } = useHighlighter()
+ *
+ * onMounted(async () => {
+ *   await loadLangs(import('@shikijs/langs/go'))
+ *   console.log('已加载:', loadedLangs.value)
+ * })
+ * ```
+ */
+export declare function useHighlighter(): UseHighlighterReturn;
+
+export declare interface UseHighlighterReturn {
+    /** highlighter 是否已初始化 */
+    isReady: typeof isReady;
+    /** 当前已加载的语言列表 */
+    loadedLangs: typeof loadedLangs;
+    /** 是否正在加载语言 */
+    isLoading: typeof isLoading;
+    /** 加载额外语言 */
+    loadLangs: typeof loadLangs;
+    /** 确保 highlighter 已初始化 */
+    ensureReady: typeof ensureReady;
+    /** 刷新已加载语言列表 */
+    refreshLoadedLangs: typeof refreshLoadedLangs;
+}
+
 /**
  * Vue 插件安装方法，支持 app.use() 方式全局注册
  */