flet-webview 0.2.0.dev49__tar.gz → 0.2.0.dev66__tar.gz

{flet_webview-0.2.0.dev49/src/flet_webview.egg-info → flet_webview-0.2.0.dev66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-webview
-Version: 0.2.0.dev49
+Version: 0.2.0.dev66
 Summary: Display web content in Flet apps using WebView.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0
@@ -42,7 +42,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-webview` package and add it to your project dependencies:
 
@@ -62,6 +64,6 @@ To install the `flet-webview` package and add it to your project dependencies:
     poetry add flet-webview
     ```
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](./examples).

{flet_webview-0.2.0.dev49 → flet_webview-0.2.0.dev66}/README.md

@@ -26,7 +26,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-webview` package and add it to your project dependencies:
 
@@ -46,6 +48,6 @@ To install the `flet-webview` package and add it to your project dependencies:
     poetry add flet-webview
     ```
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](./examples).

flet_webview-0.2.0.dev66/pyproject.toml

@@ -0,0 +1,97 @@
+[project]
+name = "flet-webview"
+version = "0.2.0.dev66"
+description = "Display web content in Flet apps using WebView."
+readme = "README.md"
+authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "flet >=0.70.0.dev0",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://flet-dev.github.io/flet-webview"
+Repository = "https://github.com/flet-dev/flet-webview"
+Issues = "https://github.com/flet-dev/flet-webview/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_webview" = ["**/*"]
+
+[dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
+dev = [
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
+]
+docs = [
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    "mkdocs-external-images",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
+]
+
+[tool.uv.sources]
+mkdocs-external-images = { git = "https://github.com/flet-dev/mkdocs-external-images", tag = "v0.2.0" }
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+fix = true
+show-fixes = true
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I"
+]
+preview = true
+pydocstyle = { convention = 'google' }
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

flet_webview-0.2.0.dev66/src/flet_webview/__init__.py

@@ -0,0 +1,19 @@
+from flet_webview.types import (
+    JavaScriptMode,
+    LogLevelSeverity,
+    RequestMethod,
+    WebViewConsoleMessageEvent,
+    WebViewJavaScriptEvent,
+    WebViewScrollEvent,
+)
+from flet_webview.webview import WebView
+
+__all__ = [
+    "JavaScriptMode",
+    "LogLevelSeverity",
+    "RequestMethod",
+    "WebView",
+    "WebViewConsoleMessageEvent",
+    "WebViewJavaScriptEvent",
+    "WebViewScrollEvent",
+]

{flet_webview-0.2.0.dev49 → flet_webview-0.2.0.dev66}/src/flet_webview/types.py

@@ -1,14 +1,19 @@
 from dataclasses import dataclass
 from enum import Enum
+from typing import TYPE_CHECKING
 
 import flet as ft
 
+if TYPE_CHECKING:
+    from flet_webview.webview import WebView  # noqa
+
 __all__ = [
-    "RequestMethod",
+    "JavaScriptMode",
     "LogLevelSeverity",
-    "WebViewScrollEvent",
+    "RequestMethod",
     "WebViewConsoleMessageEvent",
     "WebViewJavaScriptEvent",
+    "WebViewScrollEvent",
 ]
 
 
@@ -44,17 +49,33 @@ class LogLevelSeverity(Enum):
     """Indicates a log message was logged using the `console.log` method."""
 
 
+class JavaScriptMode(Enum):
+    """Defines the state of JavaScript support in the `WebView`."""
+
+    UNRESTRICTED = "unrestricted"
+    """JavaScript execution is unrestricted."""
+
+    DISABLED = "disabled"
+    """JavaScript execution is disabled."""
+
+
 @dataclass
-class WebViewScrollEvent(ft.Event[ft.EventControlType]):
+class WebViewScrollEvent(ft.Event["WebView"]):
     x: float
-    """The value of the horizontal offset with the origin being at the leftmost of the `WebView`."""
+    """
+    The value of the horizontal offset with the origin being at the
+    leftmost of the `WebView`.
+    """
 
     y: float
-    """The value of the vertical offset with the origin being at the topmost of the `WebView`."""
+    """
+    The value of the vertical offset with the origin being at the
+    topmost of the `WebView`.
+    """
 
 
 @dataclass
-class WebViewConsoleMessageEvent(ft.Event[ft.EventControlType]):
+class WebViewConsoleMessageEvent(ft.Event["WebView"]):
     message: str
     """The message written to the console."""
 
@@ -63,7 +84,7 @@ class WebViewConsoleMessageEvent(ft.Event[ft.EventControlType]):
 
 
 @dataclass
-class WebViewJavaScriptEvent(ft.Event[ft.EventControlType]):
+class WebViewJavaScriptEvent(ft.Event["WebView"]):
     message: str
     """The message to be displayed in the window."""
 

flet_webview-0.2.0.dev66/src/flet_webview/webview.py

@@ -0,0 +1,384 @@
+from typing import Optional
+
+import flet as ft
+
+from flet_webview.types import (
+    JavaScriptMode,
+    RequestMethod,
+    WebViewConsoleMessageEvent,
+    WebViewJavaScriptEvent,
+    WebViewScrollEvent,
+)
+
+__all__ = ["WebView"]
+
+
+@ft.control("WebView")
+class WebView(ft.ConstrainedControl):
+    """
+    Easily load webpages while allowing user interaction.
+
+    Note:
+        Works only on the following platforms: iOS, Android, macOS and Web.
+    """
+
+    url: str
+    """The URL of the web page to load."""
+
+    prevent_links: Optional[list[str]] = None
+    """List of url-prefixes that should not be followed/loaded/downloaded."""
+
+    bgcolor: Optional[ft.ColorValue] = None
+    """Defines the background color of the WebView."""
+
+    on_page_started: Optional[ft.ControlEventHandler["WebView"]] = None
+    """
+    Fires soon as the first loading process of the webview page is started.
+
+    Event handler argument's [`data`][flet.Event.data] property is of type
+    `str` and contains the URL.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_page_ended: Optional[ft.ControlEventHandler["WebView"]] = None
+    """
+    Fires when all the webview page loading processes are ended.
+
+    Event handler argument's [`data`][flet.Event.data] property is of type `str`
+    and contains the URL.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_web_resource_error: Optional[ft.ControlEventHandler["WebView"]] = None
+    """
+    Fires when there is error with loading a webview page resource.
+
+    Event handler argument's [`data`][flet.Event.data] property is of type
+    `str` and contains the error message.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_progress: Optional[ft.ControlEventHandler["WebView"]] = None
+    """
+    Fires when the progress of the webview page loading is changed.
+
+    Event handler argument's [`data`][flet.Event.data] property is of type
+    `int` and contains the progress value.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_url_change: Optional[ft.ControlEventHandler["WebView"]] = None
+    """
+    Fires when the URL of the webview page is changed.
+
+    Event handler argument's [`data`][flet.Event.data] property is of type
+    `str` and contains the new URL.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_scroll: Optional[ft.EventHandler[WebViewScrollEvent]] = None
+    """
+    Fires when the web page's scroll position changes.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_console_message: Optional[ft.EventHandler[WebViewConsoleMessageEvent]] = None
+    """
+    Fires when a log message is written to the JavaScript console.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    on_javascript_alert_dialog: Optional[ft.EventHandler[WebViewJavaScriptEvent]] = None
+    """
+    Fires when the web page attempts to display a JavaScript alert() dialog.
+
+    Note:
+        Works only on the following platforms: iOS, Android and macOS.
+    """
+
+    def _check_mobile_or_mac_platform(self):
+        """
+        Checks/Validates support for the current platform (iOS, Android, or macOS).
+        """
+        assert self.page is not None, "WebView must be added to page first."
+        if self.page.web or self.page.platform not in [
+            ft.PagePlatform.ANDROID,
+            ft.PagePlatform.IOS,
+            ft.PagePlatform.MACOS,
+        ]:
+            raise ft.FletUnsupportedPlatformException(
+                "This method is supported on Android, iOS and macOS platforms only."
+            )
+
+    async def reload(self):
+        """
+        Reloads the current URL.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("reload")
+
+    async def can_go_back(self) -> bool:
+        """
+        Whether there's a back history item.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Returns:
+            `True` if there is a back history item, `False` otherwise.
+        """
+        self._check_mobile_or_mac_platform()
+        return await self._invoke_method("can_go_back")
+
+    async def can_go_forward(self) -> bool:
+        """
+        Whether there's a forward history item.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Returns:
+            `True` if there is a forward history item, `False` otherwise.
+        """
+        self._check_mobile_or_mac_platform()
+        return await self._invoke_method("can_go_forward")
+
+    async def go_back(self):
+        """
+        Goes back in the history of the webview, if `can_go_back()` is `True`.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("go_back")
+
+    async def go_forward(self):
+        """
+        Goes forward in the history of the webview,
+        if [`can_go_forward()`][(c).can_go_forward] is `True`.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("go_forward")
+
+    async def enable_zoom(self):
+        """
+        Enables zooming using the on-screen zoom controls and gestures.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("enable_zoom")
+
+    async def disable_zoom(self):
+        """
+        Disables zooming using the on-screen zoom controls and gestures.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("disable_zoom")
+
+    async def clear_cache(self):
+        """
+        Clears all caches used by the WebView.
+
+        The following caches are cleared:
+            - Browser HTTP Cache
+            - Cache API caches. Service workers tend to use this cache.
+            - Application cache
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("clear_cache")
+
+    async def clear_local_storage(self):
+        """
+        Clears the local storage used by the WebView.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method("clear_local_storage")
+
+    async def get_current_url(self) -> Optional[str]:
+        """
+        Gets 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.
+
+        Returns:
+            The current URL that the WebView is displaying or `None`
+                if no URL was ever loaded.
+        """
+        self._check_mobile_or_mac_platform()
+        return await self._invoke_method("get_current_url")
+
+    async def get_title(self) -> Optional[str]:
+        """
+        Get the title of the currently loaded page.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Returns:
+            The title of the currently loaded page.
+        """
+        self._check_mobile_or_mac_platform()
+        return await self._invoke_method("get_title")
+
+    async def get_user_agent(self) -> Optional[str]:
+        """
+        Get the value used for the HTTP `User-Agent:` request header.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Returns:
+            The value used for the HTTP `User-Agent:` request header.
+        """
+        self._check_mobile_or_mac_platform()
+        return await self._invoke_method("get_user_agent")
+
+    async def load_file(self, path: str):
+        """
+        Loads the provided local file.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Args:
+            path: The absolute path to the file.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            method_name="load_file",
+            arguments={"path": path},
+        )
+
+    async def load_request(self, url: str, method: RequestMethod = RequestMethod.GET):
+        """
+        Makes an HTTP request and loads the response in the webview.
+
+        Args:
+            url: The URL to load.
+            method: The HTTP method to use.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            "load_request", arguments={"url": url, "method": method}
+        )
+
+    async def run_javascript(self, value: str):
+        """
+        Runs the given JavaScript in the context of the current page.
+
+        Args:
+            value: The JavaScript code to run.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            method_name="run_javascript",
+            arguments={"value": value},
+        )
+
+    async def load_html(self, value: str, base_url: Optional[str] = None):
+        """
+        Loads the provided HTML string.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Args:
+            value: The HTML string to load.
+            base_url: The base URL to use when resolving relative URLs within the value.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            "load_html", arguments={"value": value, "base_url": base_url}
+        )
+
+    async def scroll_to(self, x: int, y: int):
+        """
+        Scrolls to the provided position of webview pixels.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Args:
+            x: The x-coordinate of the scroll position.
+            y: The y-coordinate of the scroll position.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            method_name="scroll_to",
+            arguments={"x": x, "y": y},
+        )
+
+    async def scroll_by(self, x: int, y: int):
+        """
+        Scrolls by the provided number of webview pixels.
+
+        Note:
+            Works only on the following platforms: iOS, Android and macOS.
+
+        Args:
+            x: The number of pixels to scroll by on the x-axis.
+            y: The number of pixels to scroll by on the y-axis.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            method_name="scroll_by",
+            arguments={"x": x, "y": y},
+        )
+
+    async def set_javascript_mode(self, mode: JavaScriptMode):
+        """
+        Sets the JavaScript mode of the WebView.
+
+        Note:
+            - Works only on the following platforms: iOS, Android and macOS.
+            - Disabling the JavaScript execution on the page may result to
+                unexpected web page behaviour.
+
+        Args:
+            mode: The JavaScript mode to set.
+        """
+        self._check_mobile_or_mac_platform()
+        await self._invoke_method(
+            method_name="set_javascript_mode",
+            arguments={"mode": mode},
+        )

{flet_webview-0.2.0.dev49 → flet_webview-0.2.0.dev66/src/flet_webview.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-webview
-Version: 0.2.0.dev49
+Version: 0.2.0.dev66
 Summary: Display web content in Flet apps using WebView.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0
@@ -42,7 +42,9 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
-## Installation
+## Usage
+
+### Installation
 
 To install the `flet-webview` package and add it to your project dependencies:
 
@@ -62,6 +64,6 @@ To install the `flet-webview` package and add it to your project dependencies:
     poetry add flet-webview
     ```
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](./examples).

{flet_webview-0.2.0.dev49 → flet_webview-0.2.0.dev66}/src/flutter/flet_webview/lib/src/utils/webview.dart

@@ -8,3 +8,11 @@ LoadRequestMethod? parseLoadRequestMethod(String? value,
           (e) => e.name.toLowerCase() == value.toLowerCase()) ??
       defaultValue;
 }
+
+JavaScriptMode? parseJavaScriptMode(String? value,
+    [JavaScriptMode? defaultValue]) {
+  if (value == null) return defaultValue;
+  return JavaScriptMode.values.firstWhereOrNull(
+          (e) => e.name.toLowerCase() == value.toLowerCase()) ??
+      defaultValue;
+}

{flet_webview-0.2.0.dev49 → flet_webview-0.2.0.dev66}/src/flutter/flet_webview/lib/src/webview_mobile_and_mac.dart

@@ -154,10 +154,9 @@ class _WebviewMobileAndMacState extends State<WebviewMobileAndMac> {
         }
         break;
       case "set_javascript_mode":
-        var value = parseBool(args["value"]);
-        if (value != null) {
-          await controller.setJavaScriptMode(
-              value ? JavaScriptMode.unrestricted : JavaScriptMode.disabled);
+        var mode = parseJavaScriptMode(args["mode"]);
+        if (mode != null) {
+          await controller.setJavaScriptMode(mode);
         }
         break;
       default: