@slidev/types 0.49.18 → 0.49.20

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { RouteMeta, RouteComponent, Router, RouteRecordRaw } from 'vue-router';
 import YAML from 'yaml';
-import { TransitionGroupProps, Component, MaybeRefOrGetter, App, Ref, ComputedRef } from 'vue';
+import { Component, MaybeRefOrGetter, App, Ref, ComputedRef } from 'vue';
 import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
 import { KatexOptions } from 'katex';
@@ -45,7 +45,15 @@ interface BuildArgs extends ExportArgs {
     inspect: boolean;
 }
 
-interface Headmatter {
+type BuiltinLayouts = '404' | 'center' | 'cover' | 'default' | 'end' | 'error' | 'fact' | 'full' | 'iframe-left' | 'iframe-right' | 'iframe' | 'image-left' | 'image-right' | 'image' | 'intro' | 'none' | 'quote' | 'section' | 'statement' | 'two-cols-header' | 'two-cols';
+
+interface Headmatter extends HeadmatterConfig, Frontmatter {
+    /**
+     * Default frontmatter options applied to all slides
+     */
+    defaults?: Frontmatter;
+}
+interface HeadmatterConfig extends TransitionOptions {
     /**
      * Title of the slides
      */
@@ -60,7 +68,7 @@ interface Headmatter {
     /**
      * Theme to use for the slides
      *
-     * @see https://sli.dev/themes/use.html
+     * See https://sli.dev/themes/use.html
      * @default 'default'
      */
     theme?: string;
@@ -99,7 +107,7 @@ interface Headmatter {
     /**
      * Prefer highlighter
      *
-     * @see https://sli.dev/custom/config-highlighter.html
+     * See https://sli.dev/custom/config-highlighter.html
      * @default shiki
      */
     highlighter?: 'shiki' | 'prism';
@@ -162,7 +170,7 @@ interface Headmatter {
      *
      * @default {}
      */
-    fonts?: ResolvedFontOptions;
+    fonts?: FontOptions;
     /**
      * Configure the icon for app
      *
@@ -174,7 +182,7 @@ interface Headmatter {
      *
      * @default {}
      */
-    drawings?: ResolvedDrawingsOptions;
+    drawings?: DrawingsOptions;
     /**
      * URL of PlantUML server used to render diagrams
      *
@@ -198,7 +206,7 @@ interface Headmatter {
     /**
      * Engine for Atomic CSS
      *
-     * @see https://unocss.dev/
+     * See https://unocss.dev/
      * @deprecated
      * @default 'unocss'
      */
@@ -216,26 +224,12 @@ interface Headmatter {
      */
     htmlAttrs?: Record<string, string>;
     /**
-     * Page transition, powered by Vue's <TransitionGroup/>
+     * Suppport MDC syntax
      *
-     * Built-in transitions:
-     * - fade
-     * - fade-out
-     * - slide-left
-     * - slide-right
-     * - slide-up
-     * - slide-down
+     * See https://github.com/antfu/markdown-it-mdc
      *
-     * @see https://sli.dev/guide/animations.html#pages-transitions
-     * @see https://vuejs.org/guide/built-ins/transition.html
-     */
-    transition?: BuiltinSlideTransition | string | TransitionGroupProps | null;
-    /**
-     * Suppport MDC syntax
+     * See https://content.nuxtjs.org/guide/writing/mdc
      *
-     * @see https://github.com/antfu/markdown-it-mdc
-     * @see https://content.nuxtjs.org/guide/writing/mdc
-     * @experimental
      * @default false
      */
     mdc?: boolean;
@@ -255,12 +249,6 @@ interface Headmatter {
      * Enable wake lock
      */
     wakeLock?: boolean | 'dev' | 'build';
-    /**
-     * Options for export
-     *
-     * @default {}
-     */
-    export?: ResolvedExportOptions;
     /**
      * Force the filename used when exporting the presentation.
      * The extension, e.g. .pdf, gets automatically added.
@@ -271,7 +259,7 @@ interface Headmatter {
     /**
      * Enable Monaco
      *
-     * @see https://sli.dev/custom/config-monaco.html
+     * See https://sli.dev/custom/config-monaco.html
      * @default true
      */
     monaco?: boolean | 'dev' | 'build';
@@ -303,7 +291,102 @@ interface Headmatter {
      */
     monacoRunAdditionalDeps?: string[];
 }
-interface SlidevConfig extends Required<Headmatter> {
+interface Frontmatter extends TransitionOptions {
+    /**
+     * Slide layout to use
+     *
+     * Default to 'cover' for the first slide, 'default' for the rest
+     */
+    layout?: BuiltinLayouts | string;
+    /**
+     * Custom class added to the slide root element
+     */
+    class?: string | string[] | Record<string, unknown>;
+    /**
+     * Manually specified the total clicks needed to this slide
+     *
+     * When not specified, the clicks will be calculated by the usage of v-clicks
+     *
+     * See https://sli.dev/guide/animations
+     */
+    clicks?: number;
+    /**
+     * Manually specified the total clicks needed to this slide to start
+     *
+     * @default 0
+     */
+    clicksStart?: number;
+    /**
+     * Preload the slide when the previous slide is active
+     * @default true
+     */
+    preload?: boolean;
+    /**
+     * Completely hide and disable the slide
+     */
+    hide?: boolean;
+    /**
+     * Same as `hide`, completely hide and disable the slide
+     */
+    disabled?: boolean;
+    /**
+     * hide the slide for the `<Toc>` components
+     *
+     * See https://sli.dev/builtin/components#toc
+     */
+    hideInToc?: boolean;
+    /**
+     * Override the title level for the <TitleRenderer> and <Toc> components
+     * Only if `title` has also been declared
+     */
+    level?: number;
+    /**
+     * Create a route alias that can be used in the URL or with the <Link> component
+     */
+    routeAlias?: string;
+    /**
+     * Custom zoom level for the slide
+     * @default 1
+     */
+    zoom?: number;
+    /**
+     * Store the positions of draggable elements
+     * Normally you don't need to set this manually
+     *
+     * See https://sli.dev/features/draggable
+     */
+    dragPos?: Record<string, string>[];
+    /**
+     * Includes a markdown file
+     *
+     * See https://sli.dev/guide/syntax.html#importing-slides
+     */
+    src?: string;
+}
+interface DrawingsOptions {
+    /**
+     * Persist the drawings to disk
+     * Passing string to specify the directory (default to `.slidev/drawings`)
+     *
+     * @default false
+     */
+    persist?: boolean | string;
+    /**
+     * @default true
+     */
+    enabled?: boolean | 'dev' | 'build';
+    /**
+     * Only allow drawing from presenter mode
+     *
+     * @default false
+     */
+    presenterOnly?: boolean;
+    /**
+     * Sync drawing for all instances
+     *
+     * @default true
+     */
+    syncAll?: boolean;
 }
 interface FontOptions {
     /**
@@ -353,30 +436,52 @@ interface FontOptions {
      */
     fallbacks?: boolean;
 }
-interface DrawingsOptions {
+type BuiltinSlideTransition = 'slide-up' | 'slide-down' | 'slide-left' | 'slide-right' | 'fade' | 'zoom' | 'none';
+interface TransitionOptions {
     /**
-     * Persist the drawings to disk
-     * Passing string to specify the directory (default to `.slidev/drawings`)
+     * Page transition, powered by Vue's `<TransitionGroup/>`
      *
-     * @default false
-     */
-    persist?: boolean | string;
-    /**
-     * @default true
-     */
-    enabled?: boolean | 'dev' | 'build';
-    /**
-     * Only allow drawing from presenter mode
+     * Built-in transitions:
+     * - fade
+     * - fade-out
+     * - slide-left
+     * - slide-right
+     * - slide-up
+     * - slide-down
      *
-     * @default false
-     */
-    presenterOnly?: boolean;
-    /**
-     * Sync drawing for all instances
+     * See https://sli.dev/guide/animations.html#pages-transitions
      *
-     * @default true
+     * See https://vuejs.org/guide/built-ins/transition.html
      */
-    syncAll?: boolean;
+    transition?: BuiltinSlideTransition | string | TransitionGroupProps | null;
+}
+interface TransitionGroupProps {
+    appear?: boolean;
+    persisted?: boolean;
+    tag?: string;
+    moveClass?: string;
+    css?: boolean;
+    duration?: number | {
+        enter: number;
+        leave: number;
+    };
+    enterFromClass?: string;
+    enterActiveClass?: string;
+    enterToClass?: string;
+    appearFromClass?: string;
+    appearActiveClass?: string;
+    appearToClass?: string;
+    leaveFromClass?: string;
+    leaveActiveClass?: string;
+    leaveToClass?: string;
+}
+
+interface ResolvedSlidevConfigSub {
+    export: ResolvedExportOptions;
+    drawings: ResolvedDrawingsOptions;
+    fonts: ResolvedFontOptions;
+}
+interface SlidevConfig extends Omit<Required<HeadmatterConfig>, keyof ResolvedSlidevConfigSub>, ResolvedSlidevConfigSub {
 }
 interface ResolvedFontOptions {
     sans: string[];
@@ -399,7 +504,6 @@ interface ResolvedExportOptions extends Omit<ExportArgs, 'entry' | 'theme'> {
     executablePath?: string;
     withToc?: boolean;
 }
-type BuiltinSlideTransition = 'slide-up' | 'slide-down' | 'slide-left' | 'slide-right' | 'fade' | 'zoom' | 'none';
 
 type FrontmatterStyle = 'frontmatter' | 'yaml';
 interface SlideInfoBase {
@@ -783,7 +887,7 @@ declare module 'vite' {
         /**
          * Custom internal plugin options for Slidev (advanced)
          *
-         * @see https://github.com/slidevjs/slidev/blob/main/packages/slidev/node/options.ts#L50
+         * See https://github.com/slidevjs/slidev/blob/main/packages/slidev/node/options.ts#L50
          */
         slidev?: SlidevPluginOptions;
     }
@@ -842,4 +946,4 @@ interface ClicksContext {
     readonly total: number;
 }
 
-export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type CodeRunner, type CodeRunnerContext, type CodeRunnerOutput, type CodeRunnerOutputDom, type CodeRunnerOutputError, type CodeRunnerOutputHtml, type CodeRunnerOutputText, type CodeRunnerOutputTextArray, type CodeRunnerOutputs, type CodeRunnerProviders, type CodeRunnersSetup, type CommonArgs, type ContextMenuItem, type ContextMenuSetup, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type Headmatter, type KatexSetup, type LoadedSnippets, type MarkdownTransformContext, type MarkdownTransformer, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSingleClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RawRangeAtValue, type RawSingleAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevOptions, type ResolvedSlidevUtils, type RootSetup, type RootsInfo, type RoutesSetup, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevDetectedFeatures, type SlidevEntryOptions, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type TransformersSetup, type TransformersSetupReturn, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup };
+export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type CodeRunner, type CodeRunnerContext, type CodeRunnerOutput, type CodeRunnerOutputDom, type CodeRunnerOutputError, type CodeRunnerOutputHtml, type CodeRunnerOutputText, type CodeRunnerOutputTextArray, type CodeRunnerOutputs, type CodeRunnerProviders, type CodeRunnersSetup, type CommonArgs, type ContextMenuItem, type ContextMenuSetup, type DrawingsOptions, type ExportArgs, type FontOptions, type Frontmatter, type FrontmatterStyle, type Headmatter, type HeadmatterConfig, type KatexSetup, type LoadedSnippets, type MarkdownTransformContext, type MarkdownTransformer, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSingleClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RawRangeAtValue, type RawSingleAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevConfigSub, type ResolvedSlidevOptions, type ResolvedSlidevUtils, type RootSetup, type RootsInfo, type RoutesSetup, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevDetectedFeatures, type SlidevEntryOptions, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type TransformersSetup, type TransformersSetupReturn, type TransitionGroupProps, type TransitionOptions, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup };

package/package.json

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