WebView

Examples#

Example 1#

example_1.py

import flet as ft

import flet_webview as fwv


def main(page: ft.Page):
    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,
        )
    )


ft.run(main)

WebView #

Bases: ConstrainedControl

Easily load webpages while allowing user interaction.

Note

Works only on the following platforms: iOS, Android, macOS and Web.

align #

align: Alignment | None = None

Alignment of the control within its parent.

animate_align #

animate_align: AnimationValue | None = None

Enables implicit animation of the align property.

More information here.

animate_margin #

animate_margin: AnimationValue | None = None

Enables implicit animation of the margin property.

More information here.

animate_offset #

animate_offset: AnimationValue | None = None

Enables implicit animation of the offset property.

More information here.

animate_opacity #

animate_opacity: AnimationValue | None = None

Enables implicit animation of the opacity property.

More information here.

animate_position #

animate_position: AnimationValue | None = None

Enables implicit animation of the positioning properties (left, right, top and bottom).

More information here.

animate_rotation #

animate_rotation: AnimationValue | None = None

Enables implicit animation of the rotate property.

More information here.

animate_scale #

animate_scale: AnimationValue | None = None

Enables implicit animation of the scale property.

More information here.

animate_size #

animate_size: AnimationValue | None = None

TBD

aspect_ratio #

aspect_ratio: Number | None = None

TBD

badge #

badge: BadgeValue | None = None

A badge to show on top of this control.

bgcolor #

bgcolor: ColorValue | None = None

Defines the background color of the WebView.

bottom #

bottom: Number | None = None

The distance that the child's bottom edge is inset from the bottom of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

col #

col: ResponsiveNumber = 12

If a parent of this control is a ResponsiveRow, this property is used to determine how many virtual columns of a screen this control will span.

Can be a number or a dictionary configured to have a different value for specific breakpoints, for example col={"sm": 6}.

This control spans the 12 virtual columns by default.

/// details | Dimensions type: info | Breakpoint | Dimension | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px | ///

data #

data: Any = skip_field()

Arbitrary data of any type.

disabled #

disabled: bool = False

Every control has disabled property which is False by default - control and all its children are enabled.

Note

The value of this property will be propagated down to all children controls recursively.

/// details | Example type: example For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

///

expand #

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose #

expand_loose: bool = False

Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.

More information here.

Note

If expand_loose is True, it will have effect only if:

expand is not None and
the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

height #

height: Number | None = None

Imposed Control height in virtual pixels.

key #

key: KeyValue | None = None

left #

left: Number | None = None

The distance that the child's left edge is inset from the left of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

margin #

margin: MarginValue | None = None

Sets the margin of the control.

offset #

offset: OffsetValue | None = None

Applies a translation transformation before painting the control.

The translation is expressed as an Offset scaled to the control's size. So, Offset(x=0.25, y=0), for example, will result in a horizontal translation of one quarter the width of this control.

/// details | Example type: example The following example displays container at 0, 0 top left corner of a stack as transform applies -1 * 100, -1 * 100 (offset * control's size) horizontal and vertical translations to the control:

import flet as ft

def main(page: ft.Page):
    page.add(
        ft.Stack(
            width=1000,
            height=1000,
            controls=[
                ft.Container(
                    bgcolor="red",
                    width=100,
                    height=100,
                    left=100,
                    top=100,
                    offset=ft.Offset(-1, -1),
                )
            ],
        )
    )

ft.run(main)

///

on_animation_end #

on_animation_end: (
    ControlEventHandler[LayoutControl] | None
) = None

Called when animation completes.

Can be used to chain multiple animations.

The data property of the event handler argument contains the name of the animation.

More information here.

on_console_message #

on_console_message: (
    EventHandler[WebViewConsoleMessageEvent] | None
) = 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 #

on_javascript_alert_dialog: (
    EventHandler[WebViewJavaScriptEvent] | None
) = None

Fires when the web page attempts to display a JavaScript alert() dialog.

Note

Works only on the following platforms: iOS, Android and macOS.

on_page_ended #

on_page_ended: ControlEventHandler[WebView] | None = None

Fires when all the webview page loading processes are ended.

Event handler argument's data property is of type str and contains the URL.

Note

Works only on the following platforms: iOS, Android and macOS.

on_page_started #

on_page_started: ControlEventHandler[WebView] | None = None

Fires soon as the first loading process of the webview page is started.

Event handler argument's data property is of type str and contains the URL.

Note

Works only on the following platforms: iOS, Android and macOS.

on_progress #

on_progress: ControlEventHandler[WebView] | None = None

Fires when the progress of the webview page loading is changed.

Event handler argument's data property is of type int and contains the progress value.

Note

Works only on the following platforms: iOS, Android and macOS.

on_scroll #

on_scroll: EventHandler[WebViewScrollEvent] | None = None

Fires when the web page's scroll position changes.

Note

Works only on the following platforms: iOS, Android and macOS.

on_url_change #

on_url_change: ControlEventHandler[WebView] | None = None

Fires when the URL of the webview page is changed.

Event handler argument's data property is of type str and contains the new URL.

Note

Works only on the following platforms: iOS, Android and macOS.

on_web_resource_error #

on_web_resource_error: (
    ControlEventHandler[WebView] | None
) = None

Fires when there is error with loading a webview page resource.

Event handler argument's data property is of type str and contains the error message.

Note

Works only on the following platforms: iOS, Android and macOS.

opacity #

opacity: Number = 1.0

Defines the transparency of the control.

Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque without any transparency).

page #

page: Page | BasePage | None

The page to which this control belongs to.

parent #

parent: BaseControl | None

The direct ancestor(parent) of this control.

It defaults to None and will only have a value when this control is mounted (added to the page tree).

The Page control (which is the root of the tree) is an exception - it always has parent=None.

prevent_links #

prevent_links: list[str] | None = None

List of url-prefixes that should not be followed/loaded/downloaded.

right #

right: Number | None = None

The distance that the child's right edge is inset from the right of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

rotate #

rotate: RotateValue | None = None

Transforms this control using a rotation around its center.

The value of rotate property could be one of the following types:

number - a rotation in clockwise radians. Full circle 360° is math.pi * 2 radians, 90° is pi / 2, 45° is pi / 4, etc.
Rotate - allows to specify rotation angle as well as alignment - the location of rotation center.

/// details | Example type: example For example:

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT)
)

///

rtl #

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

scale #

scale: ScaleValue | None = None

Scales this control along the 2D plane. Default scale factor is 1.0, meaning no-scale.

Setting this property to 0.5, for example, makes this control twice smaller, while 2.0 makes it twice larger.

Different scale multipliers can be specified for x and y axis, by setting Control.scale property to an instance of Scale class. Either scale or scale_x and scale_y could be specified, but not all of them.

/// details | Example type: example

ft.Image(
    src="https://picsum.photos/100/100",
    width=100,
    height=100,
    border_radius=5,
    scale=ft.Scale(scale_x=2, scale_y=0.5)
)

///

tooltip #

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

top #

top: Number | None = None

The distance that the child's top edge is inset from the top of the stack.

Note

Effective only if this control is a descendant of one of the following: Stack control, Page.overlay list.

url #

url: str

The URL of the web page to load.

visible #

visible: bool = True

Every control has visible property which is True by default - control is rendered on the page. Setting visible to False completely prevents control (and all its children if any) from rendering on a page canvas. Hidden controls cannot be focused or selected with a keyboard or mouse and they do not emit any events.

width #

width: Number | None = None

Imposed Control width in virtual pixels.

before_event #

before_event(e: ControlEvent)

before_update #

before_update()

build #

build()

Called once during control initialization to define its child controls. self.page is available in this method.

can_go_back #

can_go_back() -> bool

Whether there's a back history item.

Note

Works only on the following platforms: iOS, Android and macOS.

RETURNS	DESCRIPTION
`bool`	`True` if there is a back history item, `False` otherwise.

can_go_forward #

can_go_forward() -> bool

Whether there's a forward history item.

Note

Works only on the following platforms: iOS, Android and macOS.

RETURNS	DESCRIPTION
`bool`	`True` if there is a forward history item, `False` otherwise.

clean #

clean() -> None

clear_cache #

clear_cache()

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.

clear_local_storage #

clear_local_storage()

Clears the local storage used by the WebView.

Note

Works only on the following platforms: iOS, Android and macOS.

did_mount #

did_mount()

disable_zoom #

disable_zoom()

Disables zooming using the on-screen zoom controls and gestures.

Note

Works only on the following platforms: iOS, Android and macOS.

enable_zoom #

enable_zoom()

Enables zooming using the on-screen zoom controls and gestures.

Note

Works only on the following platforms: iOS, Android and macOS.

get_current_url #

get_current_url() -> str | None

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	DESCRIPTION
`str \| None`	The current URL that the WebView is displaying or `None` if no URL was ever loaded.

get_title #

get_title() -> str | None

Get the title of the currently loaded page.

Note

Works only on the following platforms: iOS, Android and macOS.

RETURNS	DESCRIPTION
`str \| None`	The title of the currently loaded page.

get_user_agent #

get_user_agent() -> str | None

Get the value used for the HTTP User-Agent: request header.

Note

Works only on the following platforms: iOS, Android and macOS.

RETURNS	DESCRIPTION
`str \| None`	The value used for the HTTP `User-Agent:` request header.

go_back #

go_back()

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.

go_forward #

go_forward()

Goes forward in the history of the webview, if can_go_forward() is True.

Note

Works only on the following platforms: iOS, Android and macOS.

init #

init()

is_isolated #

is_isolated()

load_file #

load_file(path: str)

Loads the provided local file.

Note

Works only on the following platforms: iOS, Android and macOS.

PARAMETER	DESCRIPTION
`path`	The absolute path to the file. TYPE: `str`

load_html #

load_html(value: str, base_url: str | None = None)

Loads the provided HTML string.

Note

Works only on the following platforms: iOS, Android and macOS.

PARAMETER	DESCRIPTION
`value`	The HTML string to load. TYPE: `str`
`base_url`	The base URL to use when resolving relative URLs within the value. TYPE: `str \| None` DEFAULT: `None`

load_request #

load_request(url: str, method: RequestMethod = GET)

Makes an HTTP request and loads the response in the webview.

PARAMETER	DESCRIPTION
`url`	The URL to load. TYPE: `str`
`method`	The HTTP method to use. TYPE: `RequestMethod` DEFAULT: `GET`

Note

Works only on the following platforms: iOS, Android and macOS.

reload #

reload()

Reloads the current URL.

Note

Works only on the following platforms: iOS, Android and macOS.

run_javascript #

run_javascript(value: str)

Runs the given JavaScript in the context of the current page.

PARAMETER	DESCRIPTION
`value`	The JavaScript code to run. TYPE: `str`

Note

Works only on the following platforms: iOS, Android and macOS.

scroll_by #

scroll_by(x: int, y: int)

Scrolls by the provided number of webview pixels.

Note

Works only on the following platforms: iOS, Android and macOS.

PARAMETER	DESCRIPTION
`x`	The number of pixels to scroll by on the x-axis. TYPE: `int`
`y`	The number of pixels to scroll by on the y-axis. TYPE: `int`

scroll_to #

scroll_to(x: int, y: int)

Scrolls to the provided position of webview pixels.

Note

Works only on the following platforms: iOS, Android and macOS.

PARAMETER	DESCRIPTION
`x`	The x-coordinate of the scroll position. TYPE: `int`
`y`	The y-coordinate of the scroll position. TYPE: `int`

set_javascript_mode #

set_javascript_mode(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.

PARAMETER	DESCRIPTION
`mode`	The JavaScript mode to set. TYPE: `JavaScriptMode`

update #

update() -> None

will_unmount #

will_unmount()