mbdlyb_ui.app
=============

.. py:module:: mbdlyb_ui.app

.. autoapi-nested-parse::

   Copyright (c) 2026 TNO-ESI
   All rights reserved.



Attributes
----------

.. autoapisummary::

   mbdlyb_ui.app.MBDLYB_MENU_CLASS
   mbdlyb_ui.app.MBDLYB_MODES
   mbdlyb_ui.app.MBDLYB_URL_RESOLVER


Classes
-------

.. autoapisummary::

   mbdlyb_ui.app.App


Functions
---------

.. autoapisummary::

   mbdlyb_ui.app.config_mapper


Module Contents
---------------

.. py:class:: App(name: str, routers: Optional[list[nicegui.APIRouter]] = None)

   Configure database access, routing, and shared UI settings for a NiceGUI app.


   .. py:method:: add_router(*routers: nicegui.APIRouter)

      Register routers with both this app and NiceGUI.

      :param \*routers: Routers containing pages served by this app.



   .. py:method:: run()

      Initialize configuration and start the NiceGUI server.



   .. py:attribute:: DEFAULT_SETTINGS
      :type:  dict[str, Any]


   .. py:attribute:: MENU_CLASS
      :type:  type[mbdlyb.gdb.GMBDNet]


   .. py:attribute:: MODES
      :value: ['Editor']



   .. py:attribute:: URL_RESOLVER
      :type:  dict[Union[type[mbdlyb.gdb.GMBDIdentifiable], str], Union[str, Callable[[mbdlyb.gdb.GMBDIdentifiable], str]]]


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: routers
      :type:  list[nicegui.APIRouter]


.. py:function:: config_mapper(mappers: list[dict], mappings: list[tuple[type[mbdlyb.gdb.GMBDElement], type[mbdlyb.gdb.GMBDElement]]])

   Copy target-class entries to corresponding source-class keys.

   :param mappers: Mutable mapping dictionaries to update in place.
   :param mappings: Pairs of source and target element classes.


.. py:data:: MBDLYB_MENU_CLASS
   :type:  type[mbdlyb.gdb.GMBDNet]

.. py:data:: MBDLYB_MODES
   :type:  list[str]
   :value: []


.. py:data:: MBDLYB_URL_RESOLVER
   :type:  dict[Union[type[mbdlyb.gdb.GMBDIdentifiable], str], Union[str, Callable[[mbdlyb.gdb.GMBDIdentifiable], str]]]