add navigation rail example tests and images

Author: OwenMcDonnell

sdk/python/examples/controls/navigation_rail/__init__.py

@@ -49,4 +49,5 @@ def main(page: ft.Page):
     )
 
 
-ft.run(main)
+if __name__ == "__main__":
+    ft.run(main)

sdk/python/examples/controls/navigation_rail/basic.py

@@ -1,12 +1,12 @@
 ---
 class_name: flet.NavigationRail
 examples: ../../examples/controls/navigation_rail
-example_images: ../../examples/controls/navigation_rail/media
+example_images: ../../test-images/examples/material/golden/macos/navigation_rail
 ---
 
 # NavigationRail
 
-{{ class_summary(class_name) }}
+{{ class_summary(class_name, example_images + "/image_for_docs.png", image_caption="Navigation rail") }}
 
 ## Examples
 

sdk/python/packages/flet/docs/controls/navigationrail/index.md

@@ -0,0 +1,51 @@
+import pytest
+
+import flet as ft
+import flet.testing as ftt
+
+from examples.controls.navigation_rail import basic
+
+
+@pytest.mark.asyncio(loop_scope="function")
+async def test_image_for_docs(flet_app_function: ftt.FletTestApp, request):
+    flet_app_function.page.theme_mode = ft.ThemeMode.LIGHT
+    await flet_app_function.assert_control_screenshot(
+        request.node.name,
+        ft.NavigationRail(
+            selected_index=0,
+            destinations=[
+                ft.NavigationRailDestination(
+                    icon=ft.Icons.STAR,
+                    label="Star",
+                ),
+                ft.NavigationRailDestination(
+                    icon=ft.Icon(ft.Icons.ADD),
+                    label="Add",
+                ),
+                ft.NavigationRailDestination(
+                    icon=ft.Icons.DELETE,
+                    label=ft.Text("Delete"),
+                ),
+            ],
+            height=200,
+            width=100,
+        ),
+    )
+
+
+@pytest.mark.parametrize(
+    "flet_app_function",
+    [{"flet_app_main": basic.main}],
+    indirect=True,
+)
+@pytest.mark.asyncio(loop_scope="function")
+async def test_basic(flet_app_function: ftt.FletTestApp):
+    flet_app_function.page.theme_mode = ft.ThemeMode.LIGHT
+    flet_app_function.page.enable_screenshots = True
+    flet_app_function.resize_page(400, 300)
+    flet_app_function.page.update()
+    await flet_app_function.tester.pump_and_settle()
+    flet_app_function.assert_screenshot(
+        "basic",
+        await flet_app_function.page.take_screenshot(),
+    )

sdk/python/packages/flet/integration_tests/examples/material/golden/macos/navigation_rail/basic.png

@@ -81,6 +81,20 @@ class NavigationRail(LayoutControl):
     """
     A material widget that is meant to be displayed at the left or right of an app to
     navigate between a small number of views, typically between three and five.
+
+    ```python
+    ft.NavigationRail(
+        selected_index=0,
+        destinations=[
+            ft.NavigationRailDestination(icon=ft.Icons.STAR, label="Star"),
+            ft.NavigationRailDestination(icon=ft.Icon(ft.Icons.ADD),label="Add"),
+            ft.NavigationRailDestination(icon=ft.Icons.DELETE, label=ft.Text("Delete")
+        ],
+        height=200,
+        width=100,
+    )
+    ```
+
     """
 
     destinations: list[NavigationRailDestination] = field(default_factory=list)