Merge pull request #448 from apjanusz/main

add possibility to hide share button and change some frontend(#406)
mljar · May 10, 2024 · 3d692ab · 3d692ab
2 parents c3d6919 + c4d103a
commit 3d692ab
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 29 deletions.
diff --git a/frontend/src/components/SideBar.tsx b/frontend/src/components/SideBar.tsx
@@ -71,6 +71,7 @@ type SideBarProps = {
   continuousUpdate: boolean;
   staticNotebook: boolean;
   allowDownload: boolean;
+  allowShare: boolean;
 };
 
 export default function SideBar({
@@ -90,6 +91,7 @@ export default function SideBar({
   continuousUpdate,
   staticNotebook,
   allowDownload,
+  allowShare,
 }: SideBarProps) {
   const dispatch = useDispatch();
   const widgetsValues: Record<string, WidgetValueType> = useSelector(
@@ -516,6 +518,7 @@ export default function SideBar({
                 notebookTitle={notebookTitle}
                 staticNotebook={staticNotebook}
                 allowDownload={allowDownload}
+                allowShare={allowShare}
                 waiting={waiting}
                 continuousUpdate={continuousUpdate}
                 runDownloadHTML={runDownloadHTML}

diff --git a/frontend/src/components/StatusBar.tsx b/frontend/src/components/StatusBar.tsx
@@ -15,6 +15,7 @@ import { setShowShareDialog } from "../slices/appSlice";
 
 type Props = {
   allowDownload: boolean;
+  allowShare: boolean;
   waiting: boolean;
   continuousUpdate: boolean;
   staticNotebook: boolean;
@@ -27,6 +28,7 @@ type Props = {
 
 export default function StatusBar({
   allowDownload,
+  allowShare,
   waiting,
   continuousUpdate,
   staticNotebook,
@@ -121,11 +123,13 @@ export default function StatusBar({
         {allowDownload && (
           <div
             className="dropdown mx-2 btn-group"
-            style={{
-              //display: "inline",
-              // width: "47%",
-              // float: continuousUpdate ? "left" : "right",
-            }}
+            style={
+              {
+                //display: "inline",
+                // width: "47%",
+                // float: continuousUpdate ? "left" : "right",
+              }
+            }
           >
             <button
               className="btn btn-sm btn-primary dropdown-toggle"
@@ -199,31 +203,33 @@ export default function StatusBar({
             </ul>
           </div>
         )}
-        <button
-          className="btn btn-sm btn-primary"
-          onClick={() => dispatch(setShowShareDialog(true))}
-          disabled={waiting}
-        >
-          <svg
-            xmlns="http://www.w3.org/2000/svg"
-            width="14"
-            height="14"
-            viewBox="0 0 24 24"
-            strokeWidth="2"
-            stroke="currentColor"
-            fill="none"
-            strokeLinecap="round"
-            strokeLinejoin="round"
+        {allowShare && (
+          <button
+            className="btn btn-sm btn-primary"
+            onClick={() => dispatch(setShowShareDialog(true))}
+            disabled={waiting}
           >
-            <path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
-            <path d="M6 12m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
-            <path d="M18 6m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
-            <path d="M18 18m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
-            <path d="M8.7 10.7l6.6 -3.4"></path>
-            <path d="M8.7 13.3l6.6 3.4"></path>
-          </svg>{" "}
-          Share
-        </button>
+            <svg
+              xmlns="http://www.w3.org/2000/svg"
+              width="14"
+              height="14"
+              viewBox="0 0 24 24"
+              strokeWidth="2"
+              stroke="currentColor"
+              fill="none"
+              strokeLinecap="round"
+              strokeLinejoin="round"
+            >
+              <path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
+              <path d="M6 12m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
+              <path d="M18 6m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
+              <path d="M18 18m-3 0a3 3 0 1 0 6 0a3 3 0 1 0 -6 0"></path>
+              <path d="M8.7 10.7l6.6 -3.4"></path>
+              <path d="M8.7 13.3l6.6 3.4"></path>
+            </svg>{" "}
+            Share
+          </button>
+        )}
       </div>
     </div>
   );

diff --git a/frontend/src/slices/notebooksSlice.ts b/frontend/src/slices/notebooksSlice.ts
@@ -41,6 +41,7 @@ export interface INotebookParams {
   show_sidebar: boolean;
   full_screen: boolean;
   allow_download: boolean;
+  allow_share: boolean;
 }
 
 export interface INotebook {

diff --git a/frontend/src/views/AppView.tsx b/frontend/src/views/AppView.tsx
@@ -189,6 +189,16 @@ function App({ isSingleApp, notebookSlug, displayEmbed }: AppProps) {
     return true;
   };
 
+  const doAllowShare = () => {
+    if (notebook !== undefined && notebook !== null) {
+      return notebook?.params?.allow_share !== undefined &&
+        notebook?.params?.allow_share !== null
+        ? notebook.params.allow_share
+        : true;
+    }
+    return true;
+  }
+
   useEffect(() => {
     if (logoFilename === "") {
       setLogoSrc(DefaultLogoSrc);
@@ -243,6 +253,7 @@ function App({ isSingleApp, notebookSlug, displayEmbed }: AppProps) {
                 continuousUpdate={notebook?.params?.continuous_update}
                 staticNotebook={notebook?.params?.static_notebook}
                 allowDownload={doAllowDownload()}
+                allowShare={doAllowShare()}
               />
             )}
 

diff --git a/frontend/src/views/HomeView.tsx b/frontend/src/views/HomeView.tsx
@@ -183,8 +183,10 @@ export default function HomeView() {
                 title={`Open ${notebook.title}`}
               >
                 <i className="fa fa-chevron-right" aria-hidden="true" />
+                <i className="fa fa-chevron-right" aria-hidden="true" />
               </button>
             )}
+
           </Link>
         </div>
       </div>

diff --git a/mercury/apps/nbworker/rest.py b/mercury/apps/nbworker/rest.py
@@ -85,6 +85,7 @@ def update_notebook(self, new_params):
             "show_sidebar",
             "full_screen",
             "allow_download",
+            "allow_share",
             "stop_on_error",
         ]:
             if new_params.get(property) is not None and nb_params.get(

diff --git a/mercury/apps/ws/utils.py b/mercury/apps/ws/utils.py
@@ -133,6 +133,7 @@ def parse_params(nb, params={}):
                         "show_sidebar",
                         "full_screen",
                         "allow_download",
+                        "allow_share",
                         "stop_on_error",
                     ]:
                         if view.get(property) is not None:
@@ -159,6 +160,8 @@ def parse_params(nb, params={}):
         params["full_screen"] = True
     if params.get("allow_download") is None:
         params["allow_download"] = True
+    if params.get("allow_share") is None:
+        params["allow_share"] = True
     if params.get("stop_on_error") is None:
         params["stop_on_error"] = False
 

diff --git a/mercury/requirements.txt b/mercury/requirements.txt
@@ -26,3 +26,4 @@ cryptography
 pyopenssl>=23.1.1
 bleach>=6.0.0
 itables>=2.0.0
+
diff --git a/mercury/widgets/app.py b/mercury/widgets/app.py
@@ -69,6 +69,10 @@ class App:
         If True (the default), a Download button is available to export results as 
         a PDF or HTML file. Set to False to hide the Download button.
 
+    allow_share : bool, default True
+        If True (the default), a Share button is available to export results as a 
+        URL. Set to False to hide the Share button.
+
     stop_on_error : bool, default False
         If True, the notebook will stop execution when an error occurs in a cell. 
         The default is False, meaning the notebook will execute all cells even with 
@@ -100,6 +104,7 @@ def __init__(
         show_sidebar=True,
         full_screen=True,
         allow_download=True,
+        allow_share=True,
         stop_on_error=False,
     ):
         self.code_uid = WidgetsManager.get_code_uid("App")
@@ -115,6 +120,7 @@ def __init__(
         self.show_sidebar = show_sidebar
         self.full_screen = full_screen
         self.allow_download = allow_download
+        self.allow_share = allow_share
         self.stop_on_error = stop_on_error
         display(self)
 
@@ -141,6 +147,7 @@ def _repr_mimebundle_(self, **kwargs):
             "show_sidebar": self.show_sidebar,
             "full_screen": self.full_screen,
             "allow_download": self.allow_download,
+            "allow_share": self.allow_share,
             "stop_on_error": self.stop_on_error,
             "model_id": "mercury-app",
             "code_uid": self.code_uid,
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,3 +26,4 @@ cryptography
		pyopenssl>=23.1.1
		bleach>=6.0.0
		itables>=2.0.0