dara-components 1.24.0__py3-none-any.whl → 1.24.2__py3-none-any.whl

dara/components/_assets/auto_js/dara.components.umd.js

@@ -62162,10 +62162,16 @@ You must set sticky: 'left' | 'right' for the '${bugWithUnderColumnsSticky.Heade
   }
   const StyledModal = core$1.injectCss(Modal$1);
   function Modal(props) {
+    const onAttemptCloseAction = core$1.useAction(props.on_attempt_close);
+    const onClosedAction = core$1.useAction(props.on_closed);
     const [style2, css2] = core$1.useComponentStyles(props, false);
     const [show, setShow] = core$1.useVariable(props.show);
     function onAttemptClose() {
-      setShow(false);
+      if (props.on_attempt_close) {
+        onAttemptCloseAction();
+      } else {
+        setShow(false);
+      }
     }
     return /* @__PURE__ */ React.createElement(
       StyledModal,
@@ -62173,6 +62179,7 @@ You must set sticky: 'left' | 'right' for the '${bugWithUnderColumnsSticky.Heade
         id: props.id_,
         $rawCss: css2,
         onAttemptClose,
+        onClosed: props.on_closed ? onClosedAction : void 0,
         render: show,
         style: { alignItems: props.align, gap: "0.75rem", justifyContent: props.justify, ...style2 }
       },

dara/components/common/modal.py

@@ -16,6 +16,7 @@ limitations under the License.
 """
 
 from dara.components.common.base_component import LayoutComponent
+from dara.core.base_definitions import Action
 from dara.core.interactivity import ClientVariable
 
 
@@ -42,9 +43,43 @@ class Modal(LayoutComponent):
 
     ```
 
+    A modal can also be closed by an external event, for example by clicking outside the modal.
+    To run something when this happens, you can pass an `on_attempt_close` action.
+    When you pass this action, the modal will not close automatically when the external event happens, it is up to the action to decide whether to close the modal.
+    You can also pass an `on_closed` action to run something when the modal has finished closing and has unmounted.
+
+    ```python
+    from dara.core.interactivity import ActionCtx, action
+    from dara.components.common import Modal, Text
+
+    show = Variable(True)
+
+    @action
+    async def on_attempt_close(ctx: ActionCtx):
+        print('Modal attempting to close')
+        ctx.update(show, False)
+
+    @action
+    async def on_closed(ctx: ActionCtx):
+        print('Modal closed')
+
+    Modal(
+        Text('Test Text'),
+        show=show,
+        on_attempt_close=on_attempt_close(),
+        on_closed=on_closed()
+    )
+
+    ```
+
     :param show: Boolean Variable instance recording the state, if True it renders the model and it's children
+    :param on_attempt_close: An optional event listener for if an external event (e.g. esc key) tries to close the modal, it's up to the
+        parent component to decide whether to close the modal. if not passed, by default the modal will set the show variable to False.
+    :param on_closed: A handler that's called when the modal has finished closing and has unmounted
     :param justify: How to justify the content of the modal, accepts any flexbox justifications
     :param align: How to align the content of the modal, accepts any flexbox alignments
     """
 
     show: ClientVariable
+    on_attempt_close: Action | None = None
+    on_closed: Action | None = None

{dara_components-1.24.0.dist-info → dara_components-1.24.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dara-components
-Version: 1.24.0
+Version: 1.24.2
 Summary: Components for the Dara Framework
 Home-page: https://dara.causalens.com/
 License: Apache-2.0
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: bokeh (==3.1.1)
 Requires-Dist: cai-causal-graph (>=0.3.6)
 Requires-Dist: certifi (>=2024.7.4)
-Requires-Dist: dara-core (==1.24.0)
+Requires-Dist: dara-core (==1.24.2)
 Requires-Dist: dill (>=0.3.0,<0.4.0)
 Requires-Dist: matplotlib (>=2.0.0)
 Requires-Dist: pandas (>=1.1.0,<3.0.0)
@@ -27,7 +27,7 @@ Description-Content-Type: text/markdown
 
 # Dara Components
 
-<img src="https://github.com/causalens/dara/blob/v1.24.0/img/dara_light.svg?raw=true">
+<img src="https://github.com/causalens/dara/blob/v1.24.2/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)

{dara_components-1.24.0.dist-info → dara_components-1.24.2.dist-info}/RECORD

@@ -2,7 +2,7 @@ dara/components/__init__.py,sha256=C_FZGdU_DrybumO2aVYEpVmSJ00WnDtVxWjlvv_HRJ8,1
 dara/components/_assets/__init__.py,sha256=WRWzSRHxObpPhbIJZ1R28PMkNvQeaz_mtcGyCDleUrQ,863
 dara/components/_assets/auto_js/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dara/components/_assets/auto_js/dara.components.css,sha256=Qm0_kcxXBDoXvvPTc7YCttkl1zMFifdcp-KufTunPNY,162729
-dara/components/_assets/auto_js/dara.components.umd.js,sha256=YqCQAkLhP2I8H9LzDOrTaQVRrzqGarYBg9XTkMnRSpI,7038674
+dara/components/_assets/auto_js/dara.components.umd.js,sha256=iLMg_ulGJu6u7kfKb8Yu2IIPzKc_pdsa3c0lgmoZs4A,7038965
 dara/components/_assets/common/bokeh-3.1.1.min.js,sha256=MbVmD3ArfHv5QtlTZlkO9QQOXQjGD1BD24RAfo9Cm3k,942380
 dara/components/_assets/common/bokeh-api-3.1.1.min.js,sha256=mXZVlXj0uhFbxfm1E4g7vSkPABdBFP1ws0FLRTYSZwc,118248
 dara/components/_assets/common/bokeh-gl-3.1.1.min.js,sha256=XzGw14TvTGCtZsW2mXMD5Ro2fVMkKk380eMyqwQN1rQ,194368
@@ -39,7 +39,7 @@ dara/components/common/image.py,sha256=ErDZ4Fv0_OzjbuqhNDDL_Nz1Q9Dq4wM7Q5aYJslCg
 dara/components/common/input.py,sha256=SPQBsekvCJRr3wbeDoA_vhWlufM0SjuaiNInPxSSPtI,2013
 dara/components/common/label.py,sha256=2wR5AWI4q8PeNbdBzNBZHmp_fM4X6GX0Ct9QfgKJ478,2477
 dara/components/common/markdown.py,sha256=E7HZuzOEgCZ0A77zLcQMijC55eF68smlNpm1dUEKsNM,1665
-dara/components/common/modal.py,sha256=3qah5c0wBxqLyQoYLqNslzJ-IlPKBzyY3IvcwgCgXUw,1524
+dara/components/common/modal.py,sha256=Ddepj4treLf_d-y8j3nLDXr5z2rLV80jSwhcmH512ys,3001
 dara/components/common/overlay.py,sha256=Po-v9oGk6cJlOyRw0JhilBdSSP3eIqd6MhuoB4-KTEQ,1802
 dara/components/common/paragraph.py,sha256=nOw-ocgjVwPj_QP8CmSHs2y3ghStTmOPGlqWx2UNMNg,2316
 dara/components/common/progress_bar.py,sha256=x3k3IZjqwMEKgXWNaBqZIQqe96d8Pgrp84QX9uM5G6U,1873
@@ -93,8 +93,8 @@ dara/components/smart/data_slicer/utils/core.py,sha256=lRONw6kGZRlISvdOIfud9eUVt
 dara/components/smart/data_slicer/utils/data_preview.py,sha256=-j77RuYWOJNQpZwEgb2iryA42DEgabq1Q8IXHkOUUe8,1697
 dara/components/smart/data_slicer/utils/plotting.py,sha256=TB00576kbA6y1eRuZBe09UAcZmluY4iJsKmYnXZ3hWQ,3389
 dara/components/smart/hierarchy.py,sha256=Q05GVG81ykwWdXcol9mqxopIrWwhhvwtT5TRF-A1j98,2871
-dara_components-1.24.0.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
-dara_components-1.24.0.dist-info/METADATA,sha256=WJKQK3HEon4xsp2bTFZNiM-64WIvSQ7M2qDi4eCueik,2687
-dara_components-1.24.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-dara_components-1.24.0.dist-info/entry_points.txt,sha256=QsM8eFLf60NfKyKgE4vstwyaDuuFXgqqgHaLdcsnhnk,70
-dara_components-1.24.0.dist-info/RECORD,,
+dara_components-1.24.2.dist-info/LICENSE,sha256=r9u1w2RvpLMV6YjuXHIKXRBKzia3fx_roPwboGcLqCc,10944
+dara_components-1.24.2.dist-info/METADATA,sha256=DD2MeNlrv3YOZtQfX4QnUekzbMcsPFoB_u3Ak5-GiqA,2687
+dara_components-1.24.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+dara_components-1.24.2.dist-info/entry_points.txt,sha256=QsM8eFLf60NfKyKgE4vstwyaDuuFXgqqgHaLdcsnhnk,70
+dara_components-1.24.2.dist-info/RECORD,,