Skip to content

Mount

Mount

Bases: GracefulDegenerationLifeCycleWrapper, MountLifeCycles

Mounts a single Page instance to the DOM.

This class handles the mounting of a single Page instance to the DOM. It ensures that only one page is mounted at a time and provides lifecycle methods for handling the mounting process.

Lifecycle:

  1. Server-side:
    • The server hydrates all app pages and overwrites the index.html file.
    • The App class toggles the visibility of the mounted page.
  2. Client-side:
    • The Mount class triggers the attached lifecycle method for the page components.

Error Handling:

  • If an error occurs during mounting, the on_error method is called with the error message.
  • This method allows components to handle errors gracefully by returning a new component to display in place of the original component.
  • If the component does not have a on_error method, a default error message component is displayed.

Parameters:

  • page: An instance of the Page class.

Returns:

None

Source code in zenaura/client/dom/mount.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class Mount(
    GracefulDegenerationLifeCycleWrapper,
    MountLifeCycles,
    ):
    """
    Mounts a single `Page` instance to the DOM.

    This class handles the mounting of a single `Page` instance to the DOM. It ensures that only one page is mounted at a time and provides lifecycle methods for handling the mounting process.

    **Lifecycle:**

    1. **Server-side:**
        - The server hydrates all app pages and overwrites the `index.html` file.
        - The `App` class toggles the visibility of the mounted page.
    2. **Client-side:**
        - The `Mount` class triggers the `attached` lifecycle method for the page components.

    **Error Handling:**

    - If an error occurs during mounting, the `on_error` method is called with the error message.
    - This method allows components to handle errors gracefully by returning a new component to display in place of the original component.
    - If the component does not have a `on_error` method, a default error message component is displayed.

    **Parameters:**

    - `page`: An instance of the `Page` class.

    **Returns:**

    None
    """

    async def mount(self, page: Page) -> None:
        """
        Mounts the given `Page` instance to the DOM.

        This method attempts to mount the provided `Page` instance to the DOM. It iterates through the page's children, updating their state in the virtual DOM and triggering the `attached` lifecycle method for each component.

        **Error Handling:**

        - If an error occurs during mounting, the `on_error` method is called with the error message.
        - This method allows components to handle errors gracefully by returning a new component to display in place of the original component.
        - If the component does not have a `on_error` method, a default error message component is displayed.

        **Parameters:**

        - `page`: An instance of the `Page` class.

        **Returns:**

        None
        """

        try:
            for comp in page.children:
                # Update state in vdom
                self.hyd_vdom_update(comp)
                # Trigger attached for page components
                await self.attached(comp)

        except Exception as e:
            self.on_error(page.children[0], traceback.format_exc())

mount(page) async

Mounts the given Page instance to the DOM.

This method attempts to mount the provided Page instance to the DOM. It iterates through the page's children, updating their state in the virtual DOM and triggering the attached lifecycle method for each component.

Error Handling:

  • If an error occurs during mounting, the on_error method is called with the error message.
  • This method allows components to handle errors gracefully by returning a new component to display in place of the original component.
  • If the component does not have a on_error method, a default error message component is displayed.

Parameters:

  • page: An instance of the Page class.

Returns:

None

Source code in zenaura/client/dom/mount.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
async def mount(self, page: Page) -> None:
    """
    Mounts the given `Page` instance to the DOM.

    This method attempts to mount the provided `Page` instance to the DOM. It iterates through the page's children, updating their state in the virtual DOM and triggering the `attached` lifecycle method for each component.

    **Error Handling:**

    - If an error occurs during mounting, the `on_error` method is called with the error message.
    - This method allows components to handle errors gracefully by returning a new component to display in place of the original component.
    - If the component does not have a `on_error` method, a default error message component is displayed.

    **Parameters:**

    - `page`: An instance of the `Page` class.

    **Returns:**

    None
    """

    try:
        for comp in page.children:
            # Update state in vdom
            self.hyd_vdom_update(comp)
            # Trigger attached for page components
            await self.attached(comp)

    except Exception as e:
        self.on_error(page.children[0], traceback.format_exc())