dara-core 1.21.23__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

@@ -44,6 +44,8 @@ from dara.core.visual.components import (
     Fallback,
     For,
     ForDef,
+    Match,
+    MatchDef,
     Menu,
     MenuDef,
     PoweredByCausalens,
@@ -89,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,

dara/core/interactivity/__init__.py

@@ -44,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
@@ -69,6 +70,7 @@ __all__ = [
     'DownloadVariable',
     'DownloadContent',
     'DownloadContentImpl',
+    'LoopVariable',
     'NavigateTo',
     'NavigateToImpl',
     'Notify',

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: