dara-core 1.21.22__py3-none-any.whl → 1.21.23__py3-none-any.whl

dara/core/defaults.py

@@ -21,6 +21,8 @@ from typing import TYPE_CHECKING, cast
 
 from dara.core.base_definitions import ActionDef
 from dara.core.interactivity.actions import (
+    CopyToClipboard,
+    CopyToClipboardDef,
     DownloadContentDef,
     DownloadVariable,
     DownloadVariableDef,
@@ -102,6 +104,7 @@ CORE_ACTIONS: dict[str, ActionDef] = {
     TriggerVariable.__name__: TriggerVariableDef,
     ResetVariables.__name__: ResetVariablesDef,
     DownloadVariable.__name__: DownloadVariableDef,
+    CopyToClipboard.__name__: CopyToClipboardDef,
     'DownloadContent': DownloadContentDef,
     Notify.__name__: NotifyDef,
 }

dara/core/interactivity/__init__.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel
 
 from dara.core.interactivity.actions import (
     ActionCtx,
+    CopyToClipboard,
     DownloadContent,
     DownloadContentImpl,
     DownloadVariable,
@@ -64,6 +65,7 @@ __all__ = [
     'DerivedVariable',
     'DerivedDataVariable',
     'UrlVariable',
+    'CopyToClipboard',
     'DownloadVariable',
     'DownloadContent',
     'DownloadContentImpl',

dara/core/interactivity/actions.py

@@ -62,6 +62,7 @@ from dara.core.internal.utils import run_user_handler
 if TYPE_CHECKING:
     from dara.core.interactivity import (
         AnyVariable,
+        ClientVariable,
         DerivedVariable,
         Variable,
     )
@@ -727,6 +728,41 @@ class DownloadVariable(ActionImpl):
     type: Literal['csv', 'xlsx', 'json'] = 'csv'
 
 
+CopyToClipboardDef = ActionDef(name='CopyToClipboard', js_module='@darajs/core', py_module='dara.core')
+
+
+class CopyToClipboard(ActionImpl):
+    """
+    CopyToClipboard action copies the provided value to the user's clipboard.
+
+    ```python
+
+    from dara.core import action, ConfigurationBuilder, CopyToClipboard
+    from dara.components import Stack, Button
+
+    config = ConfigurationBuilder()
+
+    def test_page():
+        return Stack(
+            Button(
+                'Copy to clipboard',
+                onclick=CopyToClipboard(value='Hello, World!')
+            )
+        )
+
+
+    config.router.add_page(path='copy-to-clipboard', content=test_page)
+    """
+
+    value: str | ClientVariable
+
+    success_message: str | None = None
+    """Message to display when the value is copied to the clipboard"""
+
+    error_message: str | None = None
+    """Message to display when the value could not be copied to the clipboard"""
+
+
 @deprecated('Use @action instead')
 def SideEffect(
     function: Callable[[ComponentActionContext], Any],
@@ -826,6 +862,51 @@ class ActionCtx:
         )
         self._on_action = _on_action
 
+    async def copy_to_clipboard(
+        self,
+        value: str,
+        success_message: str | None = None,
+        error_message: str | None = None,
+    ):
+        """
+        Copy a given value to the user's clipboard.
+
+        Note that this could fail in some browsers if e.g. user has disabled clipboard access.
+        Dara will display an error notification in this case, the message can be customized with the `error_message` parameter.
+
+        ```python
+
+        from dara.core import action, ConfigurationBuilder, CopyToClipboard
+        from dara.components import Stack, Button
+
+        config = ConfigurationBuilder()
+
+        @action
+        async def copy_demo(ctx: action.Ctx, value: str):
+            await ctx.copy_to_clipboard(value)
+
+        def test_page():
+            return Stack(
+                Button(
+                    'Copy to clipboard',
+                    onclick=copy_demo(value='Hello, World!')
+                )
+            )
+
+
+        config.router.add_page(path='copy-to-clipboard', content=test_page)
+        ```
+
+        :param value: the value to copy to the clipboard
+        :param success_message: the message to display when the value is copied to the clipboard
+        :param error_message: the message to display when the value could not be copied to the clipboard
+        """
+        return await CopyToClipboard(
+            value=value,
+            success_message=success_message,
+            error_message=error_message,
+        ).execute(self)
+
     @overload
     async def update(self, variable: ServerVariable, value: DataFrame | None): ...
 

dara/core/umd/dara.core.umd.cjs

@@ -9364,7 +9364,7 @@
 
     background-color: ${(props) => props.theme.colors.blue1};
 `;
-  (function(thisArg, _arguments, P, generator) {
+  var __awaiter$2 = function(thisArg, _arguments, P, generator) {
     function adopt(value) {
       return value instanceof P ? value : new P(function(resolve) {
         resolve(value);
@@ -9390,7 +9390,35 @@
       }
       step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
-  });
+  };
+  function copyToClipboard(value) {
+    return __awaiter$2(this, void 0, void 0, function* () {
+      let success2 = true;
+      if (navigator.clipboard) {
+        try {
+          yield navigator.clipboard.writeText(value);
+        } catch (_a) {
+          success2 = false;
+        }
+      } else {
+        const tempComponent = document.createElement("textarea");
+        tempComponent.value = value;
+        tempComponent.style.top = "0";
+        tempComponent.style.left = "0";
+        tempComponent.style.position = "fixed";
+        document.body.appendChild(tempComponent);
+        tempComponent.focus();
+        tempComponent.select();
+        try {
+          success2 = document.execCommand("copy");
+        } catch (_b) {
+          success2 = false;
+        }
+        document.body.removeChild(tempComponent);
+      }
+      return success2;
+    });
+  }
   var Status;
   (function(Status2) {
     Status2["CANCELED"] = "CANCELED";
@@ -98078,6 +98106,39 @@ body,
       title: actionImpl.title
     });
   };
+  const CopyToClipboard = async (ctx, actionImpl) => {
+    let value;
+    if (!isVariable(actionImpl.value)) {
+      value = actionImpl.value;
+    } else {
+      if (!isSingleVariable(actionImpl.value)) {
+        throw new UserError("CopyToClipboard only supports simple Variables");
+      }
+      value = await resolveVariable(
+        actionImpl.value,
+        ctx.wsClient,
+        ctx.taskCtx,
+        ctx.extras,
+        (v) => ctx.snapshot.getPromise(v)
+      );
+    }
+    const success2 = await copyToClipboard(value);
+    if (!success2) {
+      ctx.notificationCtx.pushNotification({
+        key: "_copyToClipboard",
+        message: actionImpl.error_message ?? "",
+        status: Status.ERROR,
+        title: "Error copying to clipboard"
+      });
+    } else {
+      ctx.notificationCtx.pushNotification({
+        key: "_copyToClipboard",
+        message: actionImpl.success_message ?? "",
+        status: Status.SUCCESS,
+        title: "Copied to clipboard"
+      });
+    }
+  };
   const MenuItem = styled(NavLink)`
     cursor: pointer;
 
@@ -98576,6 +98637,7 @@ body,
   exports.ComponentType = ComponentType;
   exports.ConditionOperator = ConditionOperator;
   exports.ConfigContextProvider = ConfigContextProvider;
+  exports.CopyToClipboard = CopyToClipboard;
   exports.CustomFallback = DefaultFallback;
   exports.DARA_JWT_TOKEN = DARA_JWT_TOKEN;
   exports.DEFAULT_BUS = DEFAULT_BUS;

{dara_core-1.21.22.dist-info → dara_core-1.21.23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dara-core
-Version: 1.21.22
+Version: 1.21.23
 Summary: Dara Framework Core
 Home-page: https://dara.causalens.com/
 License: Apache-2.0
@@ -21,10 +21,10 @@ Requires-Dist: cachetools (>=5.0.0,<6.0.0)
 Requires-Dist: certifi (>=2024.7.4)
 Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: colorama (>=0.4.6,<0.5.0)
-Requires-Dist: create-dara-app (==1.21.22)
+Requires-Dist: create-dara-app (==1.21.23)
 Requires-Dist: croniter (>=6.0.0,<7.0.0)
 Requires-Dist: cryptography (>=42.0.4)
-Requires-Dist: dara-components (==1.21.22) ; extra == "all"
+Requires-Dist: dara-components (==1.21.23) ; extra == "all"
 Requires-Dist: exceptiongroup (>=1.1.3,<2.0.0)
 Requires-Dist: fastapi (>=0.115.0,<0.121.0)
 Requires-Dist: fastapi_vite_dara (==0.4.0)
@@ -55,7 +55,7 @@ Description-Content-Type: text/markdown
 
 # Dara Application Framework
 
-<img src="https://github.com/causalens/dara/blob/v1.21.22/img/dara_light.svg?raw=true">
+<img src="https://github.com/causalens/dara/blob/v1.21.23/img/dara_light.svg?raw=true">
 
 ![Master tests](https://github.com/causalens/dara/actions/workflows/tests.yml/badge.svg?branch=master)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -100,7 +100,7 @@ source .venv/bin/activate
 dara start
 ```
 
-![Dara App](https://github.com/causalens/dara/blob/v1.21.22/img/components_gallery.png?raw=true)
+![Dara App](https://github.com/causalens/dara/blob/v1.21.23/img/components_gallery.png?raw=true)
 
 Note: `pip` installation uses [PEP 660](https://peps.python.org/pep-0660/) `pyproject.toml`-based editable installs which require `pip >= 21.3` and `setuptools >= 64.0.0`. You can upgrade both with:
 
@@ -117,9 +117,9 @@ Explore some of our favorite apps - a great way of getting started and getting t
 
 | Dara App                                                                                                 | Description                                                                                                                                                                                                       |
 | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ![Large Language Model](https://github.com/causalens/dara/blob/v1.21.22/img/llm.png?raw=true)              | Demonstrates how to use incorporate a LLM chat box into your decision app to understand model insights                                                                                                            |
-| ![Plot Interactivity](https://github.com/causalens/dara/blob/v1.21.22/img/plot_interactivity.png?raw=true) | Demonstrates how to enable the user to interact with plots, trigger actions based on clicks, mouse movements and other interactions with `Bokeh` or `Plotly` plots                                                |
-| ![Graph Editor](https://github.com/causalens/dara/blob/v1.21.22/img/graph_viewer.png?raw=true)             | Demonstrates how to use the `CausalGraphViewer` component to display your graphs or networks, customising the displayed information through colors and tooltips, and updating the page based on user interaction. |
+| ![Large Language Model](https://github.com/causalens/dara/blob/v1.21.23/img/llm.png?raw=true)              | Demonstrates how to use incorporate a LLM chat box into your decision app to understand model insights                                                                                                            |
+| ![Plot Interactivity](https://github.com/causalens/dara/blob/v1.21.23/img/plot_interactivity.png?raw=true) | Demonstrates how to enable the user to interact with plots, trigger actions based on clicks, mouse movements and other interactions with `Bokeh` or `Plotly` plots                                                |
+| ![Graph Editor](https://github.com/causalens/dara/blob/v1.21.23/img/graph_viewer.png?raw=true)             | Demonstrates how to use the `CausalGraphViewer` component to display your graphs or networks, customising the displayed information through colors and tooltips, and updating the page based on user interaction. |
 
 Check out our [App Gallery](https://dara.causalens.com/gallery) for more inspiration!
 
@@ -146,9 +146,9 @@ And the supporting UI packages and tools.
 - `ui-utils` - miscellaneous utility functions
 - `ui-widgets` - widget components
 
-More information on the repository structure can be found in the [CONTRIBUTING.md](https://github.com/causalens/dara/blob/v1.21.22/CONTRIBUTING.md) file.
+More information on the repository structure can be found in the [CONTRIBUTING.md](https://github.com/causalens/dara/blob/v1.21.23/CONTRIBUTING.md) file.
 
 ## License
 
-Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.21.22/LICENSE).
+Dara is open-source and licensed under the [Apache 2.0 License](https://github.com/causalens/dara/blob/v1.21.23/LICENSE).
 

{dara_core-1.21.22.dist-info → dara_core-1.21.23.dist-info}/RECORD

@@ -11,11 +11,11 @@ dara/core/cli.py,sha256=i9-Xtdee80b153TSU9fFSWbHQYCi01ci_Lo8SzwnW7M,8130
 dara/core/configuration.py,sha256=PAxtnIF86kRh3D7DrdB3lxwl2QkA008aKSykvcLGlCE,23353
 dara/core/css.py,sha256=c1TMGzOcXYIy-qU-TxeirGlq2BNEigP80eDG3ItjRbU,1740
 dara/core/data_utils.py,sha256=haR-SPCFm90RfOIndPBGOpFtOEmhiJgizmzcqzZOZBg,12455
-dara/core/defaults.py,sha256=b65eh02Xcsl9kinIch_MYOMEklcs7M7pfJ_oCpWiIs8,4734
+dara/core/defaults.py,sha256=lmVSGKnc5NQMsBtQArLrb_jI_BBDrgzbNNAvZ5GvKYI,4829
 dara/core/definitions.py,sha256=uf8dVhEff9LMBLEK4SaZjod_WP5PH2jnuasni__ZeL8,18010
 dara/core/http.py,sha256=gFkUV3jBY6lx0ZIIzeFw8zEH6WAb8uIKfo_t8heZDEw,4739
-dara/core/interactivity/__init__.py,sha256=LTH2OOGtJSE4684xVrkjQXpxUMlf7_re8joIOm0EjV8,2728
-dara/core/interactivity/actions.py,sha256=zK5316fT_bhg2LwXFhrtfqzoHBOi6SSzXw6EeuKgElk,48281
+dara/core/interactivity/__init__.py,sha256=uHIKFBs2ifHeM-VxhcSVqr2RgYmo1anuP5lfVcYXTFU,2772
+dara/core/interactivity/actions.py,sha256=AOvOGnl0rgf5QYpwccM9kFMiehMSRw84HUSAVHmdZRA,50741
 dara/core/interactivity/any_data_variable.py,sha256=qnJAgTV_AleBwobz2GovezvX2pXrcSwD18yKQPjt32I,306
 dara/core/interactivity/any_variable.py,sha256=mOCBW5m1CCM-gzOMlN-rnlAIktb2rZJAPWE-WKiR3-A,13648
 dara/core/interactivity/client_variable.py,sha256=Ku59TBDXrqEsMkc-upQ_GspWqHGBdtisDvpzGV6NUSs,2289
@@ -93,7 +93,7 @@ dara/core/router/compat.py,sha256=B83wq46AwQARTDfZwGrpr0slrnQmi_T7shOUNpqltSM,31
 dara/core/router/components.py,sha256=Wsf_bBnnN-1EE5jhbjPSOyDv_TVKEsY4royyOQOazM4,6132
 dara/core/router/dependency_graph.py,sha256=A0xGuZWSOCGs7rwHbeZC5vLvZouUt-2fnEX9VM2Ukp0,2280
 dara/core/router/router.py,sha256=5Nh7ms7ynnUWEV1FuCus-XvGp4NAe4OB1jdS2x5SS7Q,31249
-dara/core/umd/dara.core.umd.cjs,sha256=Dr1ETPDiQP02GRMLVzBm8HqwOKGy5rzf092opFSXKww,5146527
+dara/core/umd/dara.core.umd.cjs,sha256=zonfzOidVkoHJ_8lfFcEszljMmUxeVF_9ZY8qU-iLHo,5148440
 dara/core/umd/style.css,sha256=yT3PKpi2sKI2-kQIF8xtVbTPQqgpK7-Ua7tfzDPuSsI,4095881
 dara/core/visual/__init__.py,sha256=QN0wbG9HPQ_vXh8BO8DnBXeYLIENVTNtRmYzZf1lx7c,577
 dara/core/visual/components/__init__.py,sha256=nmCsnMLXeZAjkhMYz-mIFodpVY-69IO1fvwwXbFlMQ4,2447
@@ -120,8 +120,8 @@ dara/core/visual/themes/__init__.py,sha256=aM4mgoIYo2neBSw5FRzswsht7PUKjLthiHLmF
 dara/core/visual/themes/dark.py,sha256=UQGDooOc8ric73eHs9E0ltYP4UCrwqQ3QxqN_fb4PwY,1942
 dara/core/visual/themes/definitions.py,sha256=jywX4ObSPSW5ppm5mki50L_dPEIeAWweYre1C225STk,2697
 dara/core/visual/themes/light.py,sha256=-Tviq8oEwGbdFULoDOqPuHO0UpAZGsBy8qFi0kAGolQ,1944
-dara_core-1.21.22.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
-dara_core-1.21.22.dist-info/METADATA,sha256=lOkQxEZJQ1KRZ3hzzWrDpJ5kRroEcwCCUX9mI1Ez-Po,7541
-dara_core-1.21.22.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-dara_core-1.21.22.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
-dara_core-1.21.22.dist-info/RECORD,,
+dara_core-1.21.23.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
+dara_core-1.21.23.dist-info/METADATA,sha256=G4yr8A5kaAmu4SzGoTjU1yJnrxxItWluQxn5aSkvVuI,7541
+dara_core-1.21.23.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+dara_core-1.21.23.dist-info/entry_points.txt,sha256=H__D5sNIGuPIhVam0DChNL-To5k8Y7nY7TAFz9Mz6cc,139
+dara_core-1.21.23.dist-info/RECORD,,