@slidev/types 0.38.5 → 0.38.7

package/dist/index.d.ts

@@ -1,14 +1,36 @@
+import { TransitionProps, App, Ref } from 'vue';
 import { Awaitable } from '@antfu/utils';
 import * as Shiki from 'shiki';
 import { IThemeRegistration, ILanguageRegistration, Highlighter } from 'shiki';
 import * as monaco from 'monaco-editor';
-import { App, Ref } from 'vue';
 import { Router } from 'vue-router';
 import mermaid from 'mermaid';
 import { KatexOptions } from 'katex';
 import { WindiCssOptions } from 'vite-plugin-windicss';
 import { VitePluginConfig } from 'unocss/vite';
 
+interface CommonArgs {
+    entry: string;
+    theme?: string;
+}
+interface ExportArgs extends CommonArgs {
+    output?: string;
+    format?: string;
+    timeout?: number;
+    range?: string;
+    dark?: boolean;
+    'with-clicks'?: boolean;
+    'executable-path'?: string;
+    'with-toc'?: boolean;
+}
+interface BuildArgs extends ExportArgs {
+    watch: boolean;
+    out: string;
+    base?: string;
+    download?: boolean;
+    inspect: boolean;
+}
+
 interface SlidevConfig {
     title: string;
     /**
@@ -51,6 +73,12 @@ interface SlidevConfig {
      * @default false
      */
     download: boolean | string;
+    /**
+     * Options for export
+     *
+     * @default {}
+     */
+    export: ResolvedExportOptions;
     /**
      * Show a copy button in code blocks
      *
@@ -184,6 +212,20 @@ interface SlidevConfig {
      * @default {}
      */
     htmlAttrs: Record<string, string>;
+    /**
+     * Page transition, powered by Vue Transition
+     *
+     * @see https://vuejs.org/guide/built-ins/transition.html
+     * @experimental
+     */
+    pageTransition: TransitionProps & {
+        /**
+         * Use crossfade transition
+         *
+         * @default true
+         */
+        crossfade?: boolean;
+    };
 }
 interface FontOptions {
     /**
@@ -274,6 +316,11 @@ interface ResolvedDrawingsOptions {
     presenterOnly: boolean;
     syncAll: boolean;
 }
+interface ResolvedExportOptions extends Omit<ExportArgs, 'entry' | 'theme'> {
+    withClicks?: boolean;
+    executablePath?: string;
+    withToc?: boolean;
+}
 
 interface SlideInfoBase {
     raw: string;
@@ -323,7 +370,7 @@ interface SlidevMarkdown {
 }
 interface SlidevPreparserExtension {
     name: string;
-    transformRawLines?(lines: string[]): Promise<void>;
+    transformRawLines?(lines: string[]): Promise<void> | void;
     transformSlide?(content: string, frontmatter: any): Promise<string | undefined>;
 }
 type PreparserExtensionLoader = (headmatter?: Record<string, unknown>, filepath?: string) => Promise<SlidevPreparserExtension[]>;
@@ -401,4 +448,4 @@ interface TocItem {
     title?: string;
 }
 
-export { AppContext, AppSetup, DrawingsOptions, FontOptions, KatexSetup, MermaidOptions, MermaidSetup, MonacoSetup, MonacoSetupReturn, NavOperations, PreparserExtensionFromHeadmatter, PreparserExtensionLoader, PreparserSetup, RenderContext, ResolvedDrawingsOptions, ResolvedFontOptions, ShikiDarkModeThemes, ShikiOptions, ShikiSetup, ShortcutOptions, ShortcutsSetup, SlideInfo, SlideInfoBase, SlideInfoExtended, SlideInfoWithPath, SlidevConfig, SlidevFeatureFlags, SlidevMarkdown, SlidevPreparserExtension, SlidevThemeConfig, SlidevThemeMeta, TocItem, UnoSetup, WindiSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup, defineWindiSetup };
+export { AppContext, AppSetup, BuildArgs, CommonArgs, DrawingsOptions, ExportArgs, FontOptions, KatexSetup, MermaidOptions, MermaidSetup, MonacoSetup, MonacoSetupReturn, NavOperations, PreparserExtensionFromHeadmatter, PreparserExtensionLoader, PreparserSetup, RenderContext, ResolvedDrawingsOptions, ResolvedExportOptions, ResolvedFontOptions, ShikiDarkModeThemes, ShikiOptions, ShikiSetup, ShortcutOptions, ShortcutsSetup, SlideInfo, SlideInfoBase, SlideInfoExtended, SlideInfoWithPath, SlidevConfig, SlidevFeatureFlags, SlidevMarkdown, SlidevPreparserExtension, SlidevThemeConfig, SlidevThemeMeta, TocItem, UnoSetup, WindiSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup, defineWindiSetup };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.38.5",
+  "version": "0.38.7",
   "description": "Shared types declerations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",