docs update

Author: ndonkoHenri

docs/index.md

@@ -22,6 +22,32 @@ This package supports the following platforms:
 | Android  |     ✅     |
 | Web      |     ✅     |
 
+## Usage
+
+### Installation
+
+To install the `flet-webview` package and add it to your project dependencies:
+
+=== "uv"
+
+```bash
+uv add flet-webview
+```
+
+=== "pip"
+
+```bash
+pip install flet-webview
+```
+
+    You will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+=== "poetry"
+
+```bash
+poetry add flet-webview
+```
+
 ## Example
 
 ```python title="main.py"

examples/webview_example/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
-name = "webview_example"
+name = "flet-webview-example"
 version = "1.0.0"
-description = "Flet Webview Example"
+description = "flet-webview-example"
 readme = "README.md"
 license = "Apache-2.0"
 requires-python = ">=3.10"
@@ -13,26 +13,9 @@ dependencies = [
 # Docs: https://flet.dev/docs/publish
 [tool.flet]
 org = "com.mycompany"
-product = "Flet Webview Example"
+product = "flet-webview-example"
 company = "Flet"
 copyright = "Copyright (C) 2025 by Flet"
 
 [tool.flet.app]
 path = "src"
-
-[tool.flet.dev_packages]
-flet-webview = "../.."
-flet = "../../../flet/sdk/python/packages/flet"
-
-[tool.uv]
-dev-dependencies = [
-    "flet",
-    "flet-cli",
-    "flet-desktop",
-]
-
-[tool.uv.sources]
-flet-webview = { path = "../../", editable = true }
-flet = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet", rev = "v1" }
-flet-cli = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-cli", rev = "v1" }
-flet-desktop = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/packages/flet-desktop", rev = "v1" }

examples/webview_example/src/main.py

@@ -4,14 +4,15 @@
 
 
 def main(page: ft.Page):
-    wv = fwv.WebView(
-        url="https://flet.dev",
-        on_page_started=lambda _: print("Page started"),
-        on_page_ended=lambda _: print("Page ended"),
-        on_web_resource_error=lambda e: print("Page error:", e.data),
-        expand=True,
+    page.add(
+        fwv.WebView(
+            url="https://flet.dev",
+            on_page_started=lambda _: print("Page started"),
+            on_page_ended=lambda _: print("Page ended"),
+            on_web_resource_error=lambda e: print("WebView error:", e.data),
+            expand=True,
+        )
     )
-    page.add(wv)
 
 
-ft.app(main)
+ft.run(main)

mkdocs.yml

@@ -47,6 +47,7 @@ theme:
     - content.code.annotate
     - content.code.copy
     - content.code.select
+    - content.tabs.link
     # - navigation.tabs
     - navigation.instant
     - navigation.tracking
@@ -105,6 +106,7 @@ plugins:
   - mike:
       alias_type: symlink
   - glightbox
+  - section-index
   - mkdocstrings:
       default_handler: python_xref
       handlers:
@@ -137,23 +139,42 @@ plugins:
 
 # Markdown Extensions
 markdown_extensions:
+  - abbr
   - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
   - toc:
       permalink: "#"
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
   - pymdownx.superfences
-  - pymdownx.details
+  - pymdownx.snippets
   - pymdownx.magiclink:
       repo_url_shorthand: true
   - pymdownx.tabbed:
       alternate_style: true
-  - attr_list
-  - md_in_html
-  - def_list
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower
   - pymdownx.tasklist:
       custom_checkbox: true
+  - pymdownx.tilde

pyproject.toml

@@ -32,6 +32,7 @@ docs = [
     "markdown>=3.6",
     "pymdown-extensions",
     "mkdocs-glightbox",
+    "mkdocs-section-index",
     "pygments>=2.16",
 ]
 
@@ -41,3 +42,35 @@ flet = { git = "https://github.com/flet-dev/flet", subdirectory = "sdk/python/pa
 [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"
+]
+ignore = [
+    # Pyflakes
+    "F401", # unused import
+]
+preview = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

src/flet_webview/types.py

@@ -45,7 +45,7 @@ class LogLevelSeverity(Enum):
 
 
 @dataclass
-class WebViewScrollEvent(ft.ControlEvent):
+class WebViewScrollEvent(ft.Event[ft.EventControlType]):
     x: float
     """The value of the horizontal offset with the origin being at the leftmost of the `WebView`."""
 
@@ -54,7 +54,7 @@ class WebViewScrollEvent(ft.ControlEvent):
 
 
 @dataclass
-class WebViewConsoleMessageEvent(ft.ControlEvent):
+class WebViewConsoleMessageEvent(ft.Event[ft.EventControlType]):
     message: str
     """The message written to the console."""
 
@@ -63,7 +63,7 @@ class WebViewConsoleMessageEvent(ft.ControlEvent):
 
 
 @dataclass
-class WebViewJavaScriptEvent(ft.ControlEvent):
+class WebViewJavaScriptEvent(ft.Event[ft.EventControlType]):
     message: str
     """The message to be displayed in the window."""
 

src/flet_webview/webview.py

@@ -38,7 +38,7 @@ class WebView(ft.ConstrainedControl):
     bgcolor: Optional[ft.ColorValue] = None
     """Defines the background color of the WebView."""
 
-    on_page_started: ft.OptionalControlEventCallable = None
+    on_page_started: ft.OptionalControlEventHandler["WebView"] = None
     """
     Fires soon as the first loading process of the webview page is started.
     
@@ -48,7 +48,7 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_page_ended: ft.OptionalControlEventCallable = None
+    on_page_ended: ft.OptionalControlEventHandler["WebView"] = None
     """
     Fires when all the webview page loading processes are ended.
     
@@ -58,7 +58,7 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_web_resource_error: ft.OptionalControlEventCallable = None
+    on_web_resource_error: ft.OptionalControlEventHandler["WebView"] = None
     """
     Fires when there is error with loading a webview page resource.
     
@@ -68,7 +68,7 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_progress: ft.OptionalControlEventCallable = None
+    on_progress: ft.OptionalControlEventHandler["WebView"] = None
     """
     Fires when the progress of the webview page loading is changed.
     
@@ -78,7 +78,7 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_url_change: ft.OptionalControlEventCallable = None
+    on_url_change: ft.OptionalControlEventHandler["WebView"] = None
     """
     Fires when the URL of the webview page is changed.
     
@@ -88,7 +88,7 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_scroll: ft.OptionalEventCallable[WebViewScrollEvent] = None
+    on_scroll: ft.OptionalEventHandler[WebViewScrollEvent["WebView"]] = None
     """
     Fires when the web page's scroll position changes.
     
@@ -98,7 +98,9 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_console_message: ft.OptionalEventCallable[WebViewConsoleMessageEvent] = None
+    on_console_message: ft.OptionalEventHandler[
+        WebViewConsoleMessageEvent["WebView"]
+    ] = None
     """
     Fires when a log message is written to the JavaScript console.
     
@@ -108,7 +110,9 @@ class WebView(ft.ConstrainedControl):
         Works only on the following platforms: iOS, Android and macOS.
     """
 
-    on_javascript_alert_dialog: ft.OptionalEventCallable[WebViewJavaScriptEvent] = None
+    on_javascript_alert_dialog: ft.OptionalEventHandler[
+        WebViewJavaScriptEvent["WebView"]
+    ] = None
     """
     Fires when the web page attempts to display a JavaScript alert() dialog.
     
@@ -362,7 +366,7 @@ def load_request(self, url: str, method: RequestMethod = RequestMethod.GET):
 
         Args:
             url (str): The URL to load.
-            method (RequestMethod): The HTTP method to use. Defaults to `RequestMethod.GET`.
+            method (RequestMethod): The HTTP method to use.
         """
         self._check_mobile_or_mac_platform()
         asyncio.create_task(self.load_request_async(url, method))
@@ -375,7 +379,7 @@ async def load_request_async(
 
         Args:
             url (str): The URL to load.
-            method (RequestMethod): The HTTP method to use. Defaults to `RequestMethod.GET`.
+            method (RequestMethod): The HTTP method to use.
 
         Note:
             Works only on the following platforms: iOS, Android and macOS.