@slidev/types 0.38.8 → 0.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +15 -13
  2. package/package.json +2 -5
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { TransitionProps, App, Ref } from 'vue';
1
+ import { TransitionGroupProps, App, Ref } from 'vue';
2
2
  import { Awaitable } from '@antfu/utils';
3
3
  import * as Shiki from 'shiki';
4
4
  import { IThemeRegistration, ILanguageRegistration, Highlighter } from 'shiki';
@@ -214,19 +214,20 @@ interface SlidevConfig {
214
214
  */
215
215
  htmlAttrs: Record<string, string>;
216
216
  /**
217
- * Page transition, powered by Vue Transition
217
+ * Page transition, powered by Vue's <TransitionGroup/>
218
218
  *
219
+ * Built-in transitions:
220
+ * - fade
221
+ * - fade-out
222
+ * - slide-left
223
+ * - slide-right
224
+ * - slide-up
225
+ * - slide-down
226
+ *
227
+ * @see https://sli.dev/guide/animations.html#pages-transitions
219
228
  * @see https://vuejs.org/guide/built-ins/transition.html
220
- * @experimental
221
- */
222
- pageTransition: TransitionProps & {
223
- /**
224
- * Use crossfade transition
225
- *
226
- * @default true
227
- */
228
- crossfade?: boolean;
229
- };
229
+ */
230
+ transition?: BuiltinSlideTransition | string | TransitionGroupProps;
230
231
  }
231
232
  interface FontOptions {
232
233
  /**
@@ -322,6 +323,7 @@ interface ResolvedExportOptions extends Omit<ExportArgs, 'entry' | 'theme'> {
322
323
  executablePath?: string;
323
324
  withToc?: boolean;
324
325
  }
326
+ type BuiltinSlideTransition = 'slide-up' | 'slide-down' | 'slide-left' | 'slide-right' | 'fade' | 'zoom' | 'none';
325
327
 
326
328
  interface SlideInfoBase {
327
329
  raw: string;
@@ -449,4 +451,4 @@ interface TocItem {
449
451
  title?: string;
450
452
  }
451
453
 
452
- 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 };
454
+ export { AppContext, AppSetup, BuildArgs, BuiltinSlideTransition, 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@slidev/types",
3
- "version": "0.38.8",
3
+ "version": "0.39.0",
4
4
  "description": "Shared types declerations for Slidev",
5
5
  "author": "antfu <anthonyfu117@hotmail.com>",
6
6
  "license": "MIT",
@@ -22,11 +22,8 @@
22
22
  "engines": {
23
23
  "node": ">=14.0.0"
24
24
  },
25
- "devDependencies": {
26
- "tsup": "^5.12.7"
27
- },
28
25
  "scripts": {
29
- "build": "tsup src/index.ts --format cjs,esm --dts --splitting",
26
+ "build": "tsup src/index.ts",
30
27
  "dev": "nr build --watch"
31
28
  }
32
29
  }