@rspress/plugin-preview 1.11.2 → 1.12.0

package/dist/index.d.ts

@@ -1,42 +1,54 @@
-import { RouteMeta, RspressPlugin } from '@rspress/shared';
-
-/**
- * remove .html extension and validate
- * @param routePath id from pathname
- * @returns normalized id
- */
-declare const normalizeId: (routePath: string) => string;
+import { RspressPlugin } from '@rspress/shared';
 
 type Options = {
     /**
-     * preview in mobile mode or not
-     * when isMobile is true, 1. aside will hide. 2. default preview component by iframe
-     * @default false
+     * @deprecated Use previewMode instead.
+     * true = 'iframe'
+     * false = 'internal'
      */
     isMobile?: boolean;
     /**
-     * position of the iframe
-     * @default 'follow'
+     * @deprecated Use iframeOptions.position instead.
      */
     iframePosition?: 'fixed' | 'follow';
+    /**
+     * internal mode: component will be rendered inside the documentation, only support react.
+     *
+     * inframe mode: component will be rendered in iframe, note that aside will hide.
+     * @default 'internal'
+     */
+    previewMode?: 'internal' | 'iframe';
+    /**
+     * enable when preview mode is iframe.
+     */
+    iframeOptions?: IframeOptions;
     /**
      * determine how to handle a internal code block without meta
      * @default 'preview'
      */
     defaultRenderMode?: 'pure' | 'preview';
 };
-declare let routeMeta: RouteMeta[];
-declare const demoRoutes: {
-    path: string;
-}[];
-declare const demoMeta: Record<string, {
-    id: string;
-    virtualModulePath: string;
-    title: string;
-}[]>;
+type IframeOptions = {
+    /**
+     * framework in the iframe
+     * @default 'react'
+     */
+    framework?: 'react' | 'solid';
+    /**
+     * position of the iframe
+     * @default 'follow'
+     */
+    position?: 'fixed' | 'follow';
+    /**
+     * dev server port for the iframe
+     * @default 7890
+     */
+    devPort?: number;
+};
+
 /**
  * The plugin is used to preview component.
  */
 declare function pluginPreview(options?: Options): RspressPlugin;
 
-export { type Options, demoMeta, demoRoutes, normalizeId, pluginPreview, routeMeta };
+export { type Options, pluginPreview };