Merge branch 'spa-content' into pr/Alyxion/2811

Author: rodja

examples/authentication_spa/main.py

@@ -1,15 +1,13 @@
 #!/usr/bin/env python3
 import html
 import uuid
-from typing import Optional, Union
 
 from nicegui import app, ui
-from nicegui.single_page_target import SinglePageTarget
 
 INDEX_URL = '/'
 SECRET_AREA_URL = '/secret_area'
 
-DUMMY_LOGINS = {"admin": "NicePass"}
+DUMMY_LOGINS = {'admin': 'NicePass'}
 
 
 def verify_authentication(url) -> str:
@@ -19,7 +17,7 @@ def verify_authentication(url) -> str:
     return '/login'
 
 
-@ui.outlet('/', on_navigate=verify_authentication)
+@ui.content('/', on_navigate=verify_authentication)
 def main_layout():
     with ui.header():
         ui.link('SPA Login Example', '/').style('text-decoration: none; color: inherit;').classes('text-h3')

examples/single_page_app_complex/main.py

@@ -1,4 +1,4 @@
-# Advanced demo showing how to use the ui.outlet and outlet.view decorators to create a nested multi-page app with a
+# Advanced demo showing how to use the ui.content decorators to create a nested multi-page app with a
 # static header, footer and menu which is shared across all pages and hidden when the user navigates to the root page.
 
 from examples.single_page_app_complex.cms_config import ServiceDefinition, SubServiceDefinition, services
@@ -8,7 +8,7 @@
 # --- Other app ---
 
 
-@ui.outlet('/other_app')  # Needs to be defined before the main outlet / to avoid conflicts
+@ui.content('/other_app')  # Needs to be defined before the / to avoid conflicts
 async def other_app_router():
     ui.label('Other app header').classes('text-h2')
     ui.html('<hr>')
@@ -17,14 +17,14 @@ async def other_app_router():
     ui.label('Other app footer')
 
 
-@other_app_router.view('/')
+@other_app_router.content('/')
 async def other_app_index():
     ui.label('Welcome to the index page of the other application')
 
 
 # --- Main app ---
 
-@ui.outlet('/')  # main app outlet
+@ui.content('/')  # main app
 async def main_router(url_path: str):
     with ui.header():
         with ui.link('', '/').style('text-decoration: none; color: inherit;'):
@@ -36,10 +36,10 @@ async def main_router(url_path: str):
         with ui.element('a').props('href="/about"'):
             ui.label('Copyright 2024 by NiceCLOUD Inc.').classes('text-h7')
     with ui.element().classes('p-8'):
-        yield {'menu_drawer': menu_drawer}  # pass menu drawer to all sub elements (views and outlets)
+        yield {'menu_drawer': menu_drawer}  # pass menu drawer to all sub elements
 
 
-@main_router.view('/')
+@main_router.content('/')
 async def main_index(menu_drawer: LeftDrawer):  # main app index page
     menu_drawer.clear()  # clear drawer
     menu_drawer.hide()  # hide drawer
@@ -61,7 +61,7 @@ async def main_index(menu_drawer: LeftDrawer):  # main app index page
     ui.markdown('Click [here](/other_app) to visit the other app.')
 
 
-@main_router.view('/about')
+@main_router.content('/about')
 async def about_page(menu_drawer: LeftDrawer):
     menu_drawer.clear()
     menu_drawer.hide()
@@ -73,7 +73,7 @@ async def about_page(menu_drawer: LeftDrawer):
     ui.label('Nice Country')
 
 
-@main_router.outlet('/services/{service_name}')  # service outlet
+@main_router.content('/services/{service_name}')
 async def services_router(service_name: str, menu_drawer: LeftDrawer):
     service: ServiceDefinition = services[service_name]
     menu_drawer.clear()
@@ -92,7 +92,7 @@ async def services_router(service_name: str, menu_drawer: LeftDrawer):
                 service_element.classes('text-white text-h6 bg-gray cursor-pointer')
                 service_element.style('text-shadow: 2px 2px #00000070;')
                 service_element.on('click', lambda url=f'/services/{service_name}/{key}': ui.navigate.to(url))
-    yield {'service': service}  # pass service object to all sub elements (views and outlets)
+    yield {'service': service}  # pass service object to all sub elements
 
 
 def update_title(service: ServiceDefinition = None,
@@ -102,7 +102,7 @@ def update_title(service: ServiceDefinition = None,
     ui.page_title(new_title)
 
 
-@services_router.view('/')  # service index page
+@services_router.content('/')  # service index page
 async def show_index(service: ServiceDefinition):
     update_title(service, None)
     with ui.row():
@@ -113,15 +113,15 @@ async def show_index(service: ServiceDefinition):
     ui.html('<br>')
 
 
-@services_router.outlet('/{sub_service_name}')  # sub service outlet
+@services_router.content('/{sub_service_name}')
 async def sub_service_router(service: ServiceDefinition, sub_service_name: str):
     sub_service: SubServiceDefinition = service.sub_services[sub_service_name]
     ui.label(f'{service.title} > {sub_service.title}').classes('text-h4')
     ui.html('<br>')
-    yield {'sub_service': sub_service}  # pass sub_service object to all sub elements (views and outlets)
+    yield {'sub_service': sub_service}  # pass sub_service object to all sub elements
 
 
-@sub_service_router.view('/')  # sub service index page
+@sub_service_router.content('/')
 async def sub_service_index(service: ServiceDefinition, sub_service: SubServiceDefinition):
     update_title(service, sub_service)
     ui.label(sub_service.emoji).classes('text-h1')

nicegui/builder_utils.py

@@ -45,8 +45,13 @@ def run_safe(builder, type_check: bool = True, **kwargs) -> Any:
                         raise TypeError(
                             f'Unsupported type annotation {expected_type} for parameter {func_param_name}')
                 else:  # noqa: PLR5501
+                    # query params are always lists, so we unpack single values if the type matches
+                    if isinstance(value, list) and len(value) == 1 and isinstance(value[0], expected_type):
+                        kwargs[func_param_name] = value[0]
+
                     # Non-generic types
-                    if not isinstance(value, expected_type):
-                        raise ValueError(f'Invalid type for parameter {func_param_name}, expected {expected_type}')
+                    elif not isinstance(value, expected_type):
+                        raise ValueError(f'Invalid type for parameter {func_param_name}, '
+                                         f'expected {expected_type} but got {type(value)}')
     filtered = {k: v for k, v in kwargs.items() if k in args} if not has_kwargs else kwargs
     return builder(**filtered)

nicegui/client.py

@@ -28,8 +28,7 @@
 from .version import __version__
 
 if TYPE_CHECKING:
-    from nicegui.outlet import Outlet
-
+    from .content import Content
     from .page import page
     from .single_page_router import SinglePageRouter
 
@@ -43,7 +42,7 @@ class Client:
     page_configs: ClassVar[Dict[Callable[..., Any], page]] = {}
     '''Maps page builders to their page configuration.'''
 
-    top_level_outlets: ClassVar[Dict[str, Outlet]] = {}
+    top_level_content: ClassVar[Dict[str, Content]] = {}
     '''Maps paths to the associated single page routers.'''
 
     instances: ClassVar[Dict[str, Client]] = {}
@@ -242,9 +241,9 @@ def open(self, target: Union[Callable[..., Any], str], new_tab: bool = False) ->
         """Open a new page in the client."""
         path = target if isinstance(target, str) else self.page_routes[target]
         if not new_tab and context.client.single_page_router is not None:
-            for outlet in self.top_level_outlets.values():
-                outlet_target = outlet.resolve_target(path)
-                if outlet_target.valid and context.client.single_page_router.is_path_included(path):
+            for content in self.top_level_content.values():
+                content_target = content.resolve_target(path)
+                if content_target.valid and context.client.single_page_router.is_path_included(path):
                     context.client.single_page_router.navigate_to(path)
                     return
         self.outbox.enqueue_message('open', {'path': path, 'new_tab': new_tab}, self.id)