Add helpviewer to include import codes

minjk-bl · minjk-bl · commit c83e8fb2c090 · 2023-08-30T13:15:44.000+09:00
diff --git a/visualpython/js/com/component/HelpViewer.js b/visualpython/js/com/component/HelpViewer.js
@@ -167,14 +167,18 @@ define([
             return sbSelector.toString();
         }
 
-        open(content, useHelp=true) {
+        open(content, useHelp=true, importCode='') {
             this.show();
 
             let that = this;
 
             let code = content;
             if (useHelp === true) {
-                code = `print(help(${content}))`;
+                if (importCode !== '') {
+                    code = importCode + '\n' + `print(help(${content}))`;
+                } else {
+                    code = `print(help(${content}))`;
+                }
             }
 
             let loadingSpinner = new LoadingSpinner($(this.wrapSelector('.vp-popup-body')));
diff --git a/visualpython/js/com/component/PopupComponent.js b/visualpython/js/com/component/PopupComponent.js
@@ -122,8 +122,9 @@ define([
                 checkModules: [], // module aliases or function names
                 docs: 'https://visual-python.gitbook.io/docs/getting-started/welcome-to-visual-python',
                 helpInfo: {
-                    content: '', // method to show using help() ex) pd.DataFrame
-                    useHelp: true // custom text to show on help viewer
+                    content: '',   // method to show using help() ex) pd.DataFrame
+                    useHelp: true, // custom text to show on help viewer
+                    importCode: '' // import code for help
                 },
                 ...restConfig
             };
@@ -1227,7 +1228,7 @@ define([
         openHelpView() {
             this.closeHelpView();
             this.helpViewer = new HelpViewer();
-            this.helpViewer.open(this.config.helpInfo.content, this.config.helpInfo.useHelp);
+            this.helpViewer.open(this.config.helpInfo.content, this.config.helpInfo.useHelp, this.config.helpInfo.importCode);
         }
 
         /**
@@ -1243,11 +1244,13 @@ define([
          * Set HelpViewer content
          * @param {string} content 
          * @param {boolean} useHelp 
+         * @param {string} importCode
          */
-        setHelpContent(content, useHelp=true) {
+        setHelpContent(content, useHelp=true, importCode='') {
             this.config.helpInfo = {
                 content: content,
-                useHelp: useHelp
+                useHelp: useHelp,
+                importCode: importCode
             };
         }
 
