feat(types): ctx.themeAPI

vuejs · Dec 25, 2021 · 4269714 · 4269714
1 parent 5f1e3b0
commit 4269714
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/packages/@vuepress/types/src/context.ts b/packages/@vuepress/types/src/context.ts
@@ -91,6 +91,39 @@ export interface Page<
   date: string;
 }
 
+/**
+ * Resolve theme.
+ */
+export interface ResolvedTheme {
+  /**
+   * Theme's directory
+   */
+  path: string;
+  /**
+   * Theme's full name
+   */
+  name: string;
+  /**
+   * Theme's short name
+   */
+  shortcut: string;
+  /**
+   * Theme entry path.
+   */
+  entry: string;
+}
+
+/**
+ * Theme API.
+ */
+export interface ThemeAPI {
+  theme: ResolvedTheme;
+  parentTheme: ResolvedTheme;
+  existsParentTheme: boolean;
+  componentMap: Record<string, any>;
+  layoutComponentMap: Record<string, any>;
+}
+
 /**
  * Context API
  *
@@ -136,4 +169,8 @@ export interface Context<
    * VuePress Config.
    */
   siteConfig: C;
+  /**
+   * Theme API.
+   */
+  themeAPI: ThemeAPI;
 }