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

dara/core/base_definitions.py

@@ -454,6 +454,29 @@ class RouterPath(BaseModel):
     A URL hash string, beginning with '#'.
     """
 
+    params: dict[str, ClientVariable | Any] | None = None  # type: ignore # noqa: F821
+    """
+    Optional mapping of dynamic path params to their values.
+
+    ```python
+    from dara.core import RouterPath, Variable
+
+    foo_var = Variable('foo_value')
+
+    # Will resolve to '/foo_value/bar'
+    path = RouterPath(pathname='/:foo/:bar', params={'foo': foo_var, 'bar': 'bar'})
+
+    Link('Link to path', to=path)
+    ```
+    """
+
+    def __init__(self, **data):
+        # Resolve the circular dependency to use ClientVariable as the type of the params
+        from dara.core.interactivity.client_variable import ClientVariable  # noqa: F401
+
+        self.model_rebuild()
+        super().__init__(**data)
+
 
 class NavigateOptions(BaseModel):
     """

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,
@@ -42,6 +44,8 @@ from dara.core.visual.components import (
     Fallback,
     For,
     ForDef,
+    Match,
+    MatchDef,
     Menu,
     MenuDef,
     PoweredByCausalens,
@@ -87,6 +91,7 @@ CORE_COMPONENTS: dict[str, ComponentTypeAnnotation] = {
     cast(str, Fallback.Default.py_component): DefaultFallbackDef,
     cast(str, Fallback.Row.py_component): RowFallbackDef,
     cast(str, Fallback.Custom.py_component): CustomFallbackDef,
+    Match.__name__: MatchDef,
     For.__name__: ForDef,
     Link.__name__: LinkDef,
     Outlet.__name__: OutletDef,
@@ -102,6 +107,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,
@@ -43,6 +44,7 @@ from dara.core.interactivity.condition import Condition, Operator
 from dara.core.interactivity.data_variable import DataVariable
 from dara.core.interactivity.derived_data_variable import DerivedDataVariable
 from dara.core.interactivity.derived_variable import DerivedVariable
+from dara.core.interactivity.loop_variable import LoopVariable
 from dara.core.interactivity.non_data_variable import NonDataVariable
 from dara.core.interactivity.plain_variable import Variable
 from dara.core.interactivity.server_variable import ServerVariable
@@ -64,9 +66,11 @@ __all__ = [
     'DerivedVariable',
     'DerivedDataVariable',
     'UrlVariable',
+    'CopyToClipboard',
     'DownloadVariable',
     'DownloadContent',
     'DownloadContentImpl',
+    'LoopVariable',
     'NavigateTo',
     'NavigateToImpl',
     'Notify',

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/interactivity/loop_variable.py

@@ -2,6 +2,10 @@ from pydantic import Field, SerializerFunctionWrapHandler, model_serializer
 
 from .client_variable import ClientVariable
 
+_INDEX = '__index'
+_IS_LAST = '__is_last'
+_IS_FIRST = '__is_first'
+
 
 class LoopVariable(ClientVariable):
     """
@@ -76,6 +80,27 @@ class LoopVariable(ClientVariable):
     def __getitem__(self, key: str):
         return self.get(key)
 
+    @property
+    def index(self):
+        """
+        Value of the index of the current item in the list.
+        """
+        return self.model_copy(update={'nested': [_INDEX]}, deep=True)
+
+    @property
+    def is_last(self):
+        """
+        Whether the current item is the last item in the list.
+        """
+        return self.model_copy(update={'nested': [_IS_LAST]}, deep=True)
+
+    @property
+    def is_first(self):
+        """
+        Whether the current item is the first item in the list.
+        """
+        return self.model_copy(update={'nested': [_IS_FIRST]}, deep=True)
+
     @property
     def list_item(self):
         raise RuntimeError('LoopVariable does not support list_item')

dara/core/router/router.py

@@ -81,6 +81,44 @@ class _PathParamStore(PersistenceStore):
         pass
 
 
+class _RouteMatchStore(PersistenceStore):
+    """
+    Internal store for route matches.
+    Should not be used directly, Dara will use this internally to keep a variable
+    in sync with the current route matches.
+    """
+
+    async def init(self, variable: 'Variable'):
+        # noop
+        pass
+
+
+class RouteMatch(BaseModel):
+    """
+    Data structure representing a route match in the router
+    """
+
+    id: str
+    """
+    Route ID, as set when defining the route
+    """
+
+    pathname: str
+    """
+    Full pathname of the route
+    """
+
+    params: dict[str, Any]
+    """
+    Mapping of dynamic path params to their values
+    """
+
+    definition: 'BaseRoute'
+    """
+    Definition of the route
+    """
+
+
 class RouteData(BaseModel):
     """
     Data structure representing a route in the router
@@ -709,6 +747,12 @@ class Router(HasChildRoutes):
     building routes step by step, while the object API is more declarative and compact.
     """
 
+    route_matches: Variable[list[RouteMatch]] = Field(default_factory=lambda: Variable([], store=_RouteMatchStore()))
+    """
+    Variable containing current list of route matches.
+    Note that this will be updated by Dara automatically, so you should not modify it directly.
+    """
+
     def __init__(self, *children: BaseRoute, **kwargs):
         routes = list(children)
         if 'children' not in kwargs: