write v0.2 changelog

Author: ndonkoHenri

.github/workflows/docs.yml

@@ -13,7 +13,7 @@ on:
       - 'pyproject.toml'
       - '.github/workflows/docs.yml'
       - 'src/flet_webview/**'
-      - 'examples/webview_example/src/main.py'
+      - 'examples/webview_example/src/**'
 
   workflow_dispatch:    # Allow manual trigger from the GitHub Actions UI
 

CHANGELOG.md

@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-TBA
+- Refactored all controls to use `@flet.control` dataclass-style definition. 
 
 ## [0.1.0] - 2025-01-15
 

docs/index.md

@@ -38,12 +38,13 @@ To install the `flet-webview` package and add it to your project dependencies:
     pip install flet-webview  # (1)!
     ```
 
+    1. After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
 === "poetry"
     ```bash
     poetry add flet-webview
     ```
 
-1. After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
 
 ## Example
 

src/flet_webview/webview.py

@@ -158,6 +158,9 @@ async def can_go_back_async(self) -> bool:
         """
         Whether there's a back history item.
 
+        Returns:
+            `True` if there is a back history item, `False` otherwise.
+
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
@@ -168,6 +171,9 @@ async def can_go_forward(self) -> bool:
         """
         Whether there's a forward history item.
 
+        Returns:
+            `True` if there is a forward history item, `False` otherwise.
+
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
@@ -308,6 +314,9 @@ async def get_current_url_async(self) -> Optional[str]:
         """
         Returns the current URL that the WebView is displaying or `None` if no URL was ever loaded.
 
+        Returns:
+            The current URL that the WebView is displaying or `None` if no URL was ever loaded.
+
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
@@ -318,6 +327,9 @@ async def get_title_async(self) -> Optional[str]:
         """
         Returns the title of the currently loaded page.
 
+        Returns:
+            The title of the currently loaded page.
+
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
@@ -328,45 +340,48 @@ async def get_user_agent_async(self) -> Optional[str]:
         """
         Returns the value used for the HTTP `User-Agent:` request header.
 
+        Returns:
+            The value used for the HTTP `User-Agent:` request header.
+
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
         self._check_mobile_or_mac_platform()
         return await self._invoke_method_async("get_user_agent")
 
-    def load_file(self, absolute_path: str):
+    def load_file(self, path: str):
         """
         Loads the provided local file.
 
         Args:
-            absolute_path (str): The absolute path to the file.
+            path: The absolute path to the file.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
         self._check_mobile_or_mac_platform()
-        asyncio.create_task(self.load_file_async(absolute_path))
+        asyncio.create_task(self.load_file_async(path))
 
-    async def load_file_async(self, absolute_path: str):
+    async def load_file_async(self, path: str):
         """
         Loads the provided local file.
 
         Args:
-            absolute_path (str): The absolute path to the file.
+            path: The absolute path to the file.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
         """
         self._check_mobile_or_mac_platform()
-        await self._invoke_method_async("load_file", arguments={"path": absolute_path})
+        await self._invoke_method_async("load_file", arguments={"path": path})
 
     def load_request(self, url: str, method: RequestMethod = RequestMethod.GET):
         """
         Makes an HTTP request and loads the response in the webview.
 
         Args:
-            url (str): The URL to load.
-            method (RequestMethod): The HTTP method to use.
+            url: The URL to load.
+            method: The HTTP method to use.
         """
         self._check_mobile_or_mac_platform()
         asyncio.create_task(self.load_request_async(url, method))
@@ -378,8 +393,8 @@ async def load_request_async(
         Makes an HTTP request and loads the response in the webview.
 
         Args:
-            url (str): The URL to load.
-            method (RequestMethod): The HTTP method to use.
+            url: The URL to load.
+            method: The HTTP method to use.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -394,7 +409,7 @@ def run_javascript(self, value: str):
         Runs the given JavaScript in the context of the current page.
 
         Args:
-            value (str: The JavaScript code to run.
+            value: The JavaScript code to run.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -407,7 +422,7 @@ async def run_javascript_async(self, value: str):
         Runs the given JavaScript in the context of the current page.
 
         Args:
-            value (str): The JavaScript code to run.
+            value: The JavaScript code to run.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -420,8 +435,8 @@ def load_html(self, value: str, base_url: Optional[str] = None):
         Loads the provided HTML string.
 
         Args:
-            value (str): The HTML string to load.
-            base_url (str, optional): The base URL to use when resolving relative URLs within the value.
+            value: The HTML string to load.
+            base_url: The base URL to use when resolving relative URLs within the value.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -434,8 +449,8 @@ async def load_html_async(self, value: str, base_url: Optional[str] = None):
         Loads the provided HTML string.
 
         Args:
-            value (str): The HTML string to load.
-            base_url (str, optional): The base URL to use when resolving relative URLs within the value.
+            value: The HTML string to load.
+            base_url: The base URL to use when resolving relative URLs within the value.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -450,8 +465,8 @@ def scroll_to(self, x: int, y: int):
         Scroll to the provided position of webview pixels.
 
         Args:
-            x (int): The x-coordinate of the scroll position.
-            y (int): The y-coordinate of the scroll position.
+            x: The x-coordinate of the scroll position.
+            y: The y-coordinate of the scroll position.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -464,8 +479,8 @@ async def scroll_to_async(self, x: int, y: int):
         Scroll to the provided position of webview pixels.
 
         Args:
-            x (int): The x-coordinate of the scroll position.
-            y (int): The y-coordinate of the scroll position.
+            x: The x-coordinate of the scroll position.
+            y: The y-coordinate of the scroll position.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -478,8 +493,8 @@ def scroll_by(self, x: int, y: int):
         Scroll by the provided number of webview pixels.
 
         Args:
-            x (int): The number of pixels to scroll by on the x-axis.
-            y (int): The number of pixels to scroll by on the y-axis.
+            x: The number of pixels to scroll by on the x-axis.
+            y: The number of pixels to scroll by on the y-axis.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.
@@ -492,8 +507,8 @@ async def scroll_by_async(self, x: int, y: int):
         Scroll by the provided number of webview pixels.
 
         Args:
-            x (int): The number of pixels to scroll by on the x-axis.
-            y (int): The number of pixels to scroll by on the y-axis.
+            x: The number of pixels to scroll by on the x-axis.
+            y: The number of pixels to scroll by on the y-axis.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.