@slidev/types 0.47.5 → 0.48.0-beta.0

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import { ComputedRef } from '@vue/reactivity';
 import { TransitionGroupProps, App, Ref } from 'vue';
 import { Awaitable } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
@@ -397,6 +398,60 @@ type PreparserExtensionLoader = (headmatter?: Record<string, unknown>, filepath?
 type PreparserExtensionFromHeadmatter = (headmatter: any, exts: SlidevPreparserExtension[], filepath?: string) => Promise<SlidevPreparserExtension[]>;
 type RenderContext = 'slide' | 'overview' | 'presenter' | 'previewNext';
 type LoadedSnippets = Record<string, string>;
+type ClicksElement = Element | string;
+type ClicksRelativeEls = Map<ClicksElement, number>;
+interface ClicksInfo {
+    /**
+     * The maximum clicks, used to calculate the total clicks for current slide
+     */
+    max?: number;
+    /**
+     * The offsets added to the subsequent clicks
+     * Delta is 0 when the click is absolute
+     */
+    delta: number;
+    /**
+     * Resolved clicks
+     */
+    clicks?: number | [number, number];
+    /**
+     * Computed ref of whether the click is exactly matched
+     */
+    isCurrent?: ComputedRef<boolean>;
+    /**
+     * Computed ref of whether the click is active
+     */
+    isActive?: ComputedRef<boolean>;
+    /**
+     * Computed ref of whether the click is shown, it take flagHide into account
+     */
+    isShown?: ComputedRef<boolean>;
+    /**
+     * Having the hide flag
+     */
+    flagHide?: boolean;
+    /**
+     * Having the fade flag
+     */
+    flagFade?: boolean;
+}
+type ResolvedClicksInfo = Required<ClicksInfo>;
+type ClicksMap = Map<ClicksElement, ClicksInfo>;
+interface ClicksContext {
+    readonly disabled: boolean;
+    readonly current: number;
+    readonly relativeOffsets: ClicksRelativeEls;
+    readonly map: ClicksMap;
+    resolve: (at: string | number, size?: number) => {
+        start: number;
+        end: number;
+        delta: number;
+    };
+    register: (el: ClicksElement, info: ClicksInfo) => void;
+    unregister: (el: ClicksElement) => void;
+    readonly currentOffset: number;
+    readonly total: number;
+}
 
 interface AppContext {
     app: App;
@@ -469,4 +524,4 @@ interface TocItem {
     title?: string;
 }
 
-export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type CommonArgs, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type LoadedSnippets, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type PreparserExtensionFromHeadmatter, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlideInfoExtended, type SlideInfoWithPath, type SlidevConfig, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type TocItem, type UnoSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };
+export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type ClicksMap, type ClicksRelativeEls, type CommonArgs, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type LoadedSnippets, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type PreparserExtensionFromHeadmatter, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedClicksInfo, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlideInfoExtended, type SlideInfoWithPath, type SlidevConfig, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type TocItem, type UnoSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };

package/package.json

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