feat: add mobilePreviewUrlParams (#630)

* feat: add mobilePreviewUrlParams * fix: add default value * docs: chagnelog
ice-lab · Jan 22, 2024 · af38e3c · af38e3c · vercel · Jan 22, 2024
1 parent 591d627
commit af38e3c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/packages/plugin-docusaurus/CHANGELOG.md b/packages/plugin-docusaurus/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.4.18
+
+feat: add url params for mobilePreview
+
 ## 1.4.17
 
 ### Patch Changes

diff --git a/packages/plugin-docusaurus/package.json b/packages/plugin-docusaurus/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ice/pkg-plugin-docusaurus",
-  "version": "1.4.17",
+  "version": "1.4.18",
   "description": "@ice/pkg plugin for component and docs preview.",
   "main": "es2017/index.mjs",
   "exports": {

diff --git a/packages/plugin-docusaurus/src/remark/extractCode.js b/packages/plugin-docusaurus/src/remark/extractCode.js
@@ -15,10 +15,10 @@ const escapeCode = (code) => {
 /**
  * Remark Plugin to extract codeBlock & rendered as component
  * @type {import('unified').Plugin}
- * @param {options: { mobilePreview: boolean; baseUrl: string; }}
+ * @param {options: { mobilePreview: boolean; baseUrl: string; mobilePreviewUrlParams: string; }}
  */
 const extractCodePlugin = (options) => {
-  const { mobilePreview = false, baseUrl = '/' } = options;
+  const { mobilePreview = false, baseUrl = '/', mobilePreviewUrlParams = '' } = options;
 
   const transformer = (ast, vfile) => {
     const demosMeta = [];
@@ -53,7 +53,7 @@ const extractCodePlugin = (options) => {
           idx: index,
           demoFilename,
           demoFilepath,
-          url: path.join(baseUrl.startsWith('/') ? '' : '/', baseUrl, 'demos', demoFilename, '/'),
+          url: `${path.join(baseUrl.startsWith('/') ? '' : '/', baseUrl, 'demos', demoFilename, '/')}?${mobilePreviewUrlParams}`,
         });
         demoIndex += 1;
       }

diff --git a/packages/plugin-docusaurus/src/template/docusaurus.hbs b/packages/plugin-docusaurus/src/template/docusaurus.hbs
@@ -46,7 +46,7 @@ const config = {
           sidebarItemsGenerator: {{{sidebarItemsGenerator}}},
         {{/if}}
           remarkPlugins: [
-            [extractCode, { mobilePreview: {{mobilePreview}}, baseUrl: '{{baseUrl}}' }],
+            [extractCode, { mobilePreview: {{mobilePreview}}, baseUrl: '{{baseUrl}}', mobilePreviewUrlParams: '{{mobilePreviewUrlParams}}' }],
         {{#if remarkPlugins}}
           {{#each remarkPlugins}}
             {{{this}}},

diff --git a/packages/plugin-docusaurus/src/types.mts b/packages/plugin-docusaurus/src/types.mts
@@ -66,6 +66,10 @@ export interface PluginDocusaurusOptions {
    * Whether preview components of mobile styles
    */
   mobilePreview?: boolean;
+  /**
+   * When mobilePreview is true, the url parameters of the mobile preview page
+   */
+  mobilePreviewUrlParams?: string;
 
   /**
    * Default locale that does not have its name in the base URL