Skip to content

BasePage

Inherits: AdaptiveControl

A visual container representing a top-level view in a Flet application.

BasePage serves as the base class for Page and MultiView, and provides a unified surface for rendering application content, app bars, navigation elements, dialogs, overlays, and more. It manages one or more View instances and exposes high-level layout, scrolling, and theming properties.

Unlike lower-level layout controls (e.g., Column, Container), BasePage represents an entire logical view or screen of the app. It provides direct access to view-level controls such as AppBar, NavigationBar, FloatingActionButton, and supports system-level events like window resizing and media changes.

This class is not intended to be used directly in most apps; instead, use Page or MultiView, which extend this base functionality.

Properties

Events

Methods

  • add –

    Adds controls to the page.

  • clean –
  • insert –

    Inserts controls at specific index of page.controls list.

  • pop_dialog –

    Closes the most recently opened dialog.

  • remove –

    Removes specific controls from page.controls list.

  • remove_at –

    Remove controls from page.controls list at specific index.

  • scroll_to –

    Moves scroll position to either absolute offset, relative delta or jump to

  • show_dialog –

    Displays a dialog and manages its dismissal lifecycle.

  • take_screenshot –

    Captures a screenshot of the entire page with overlays.

  • update –

Properties#

appbar #

appbar: AppBar | CupertinoAppBar | None

Gets or sets the top application bar (AppBar or CupertinoAppBar) for the view.

The app bar typically displays the page title and optional actions such as navigation icons, menus, or other interactive elements.

auto_scroll #

auto_scroll: bool

bgcolor #

bgcolor: ColorValue | None

bottom_appbar #

bottom_appbar: BottomAppBar | None

controls #

controls: list[BaseControl]

dark_theme #

dark_theme: Theme | None = None

Customizes the theme of the application when in dark theme mode.

decoration #

decoration: BoxDecoration | None

drawer #

drawer: NavigationDrawer | None

enable_screenshots #

enable_screenshots: bool = False

Enable taking screenshots of the entire page with take_screenshot method.

end_drawer #

end_drawer: NavigationDrawer | None

floating_action_button #

floating_action_button: FloatingActionButton | None

floating_action_button_location #

floating_action_button_location: (
    FloatingActionButtonLocation | OffsetValue | None
)

foreground_decoration #

foreground_decoration: BoxDecoration | None

height #

height: Number | None = None

Page height in logical pixels.

Note
  • This property is read-only.
  • To get or set the full window height including window chrome (e.g., title bar and borders) when running a Flet app on desktop, use the height property of Page.window instead.

horizontal_alignment #

horizontal_alignment: CrossAxisAlignment

locale_configuration #

locale_configuration: LocaleConfiguration | None = None

Configures supported locales and the current locale.

media #

media: PageMediaData = field(
    default_factory=lambda: PageMediaData(
        padding=zero(),
        view_padding=zero(),
        view_insets=zero(),
        device_pixel_ratio=0,
    )
)

The current environmental metrics of the page or window.

This data is updated whenever the platform window or layout changes, such as when rotating a device, resizing a browser window, or adjusting system UI elements like the keyboard or safe areas.

navigation_bar #

navigation_bar: (
    NavigationBar | CupertinoNavigationBar | None
)

overlay #

overlay: list[BaseControl]

padding #

padding: PaddingValue | None

scroll #

scroll: ScrollMode | None

show_semantics_debugger #

show_semantics_debugger: bool | None = None

Whether to turn on an overlay that shows the accessibility information reported by the framework.

spacing #

spacing: Number

theme #

theme: Theme | None = None

Customizes the theme of the application when in light theme mode. Currently, a theme can only be automatically generated from a "seed" color. For example, to generate light theme from a green color.

theme_mode #

theme_mode: ThemeMode | None = SYSTEM

The page's theme mode.

title #

title: str | None = None

Page or window title.

vertical_alignment #

vertical_alignment: MainAxisAlignment

views #

views: list[View] = field(default_factory=lambda: [View()])

A list of views managed by the page.

Each View represents a distinct navigation state or screen in the application.

The first view in the list is considered the active one by default.

width #

width: Number | None = None

Page width in logical pixels.

Note
  • This property is read-only.
  • To get or set the full window height including window chrome (e.g., title bar and borders) when running a Flet app on desktop, use the width property of Page.window instead.

Events#

on_media_change #

on_media_change: EventHandler[PageMediaData] | None = None

Called when media has changed.

on_resize #

on_resize: EventHandler[PageResizeEvent] | None = None

Called when a user resizes a browser or native OS window containing Flet app, for example:

def page_resize(e):
    print("New page size:", page.window.width, page.window_height)

page.on_resize = page_resize

Methods#

add #

add(*controls: Control) -> None

Adds controls to the page.

page.add(ft.Text("Hello!"), ft.FilledButton("Button"))

clean #

clean() -> None

insert #

insert(at: int, *controls: Control) -> None

Inserts controls at specific index of page.controls list.

pop_dialog #

pop_dialog() -> DialogControl | None

Closes the most recently opened dialog.

This method searches the active dialog stack for the topmost dialog that is currently open, marks it as closed, updates its state, and returns the closed dialog.

Returns:

  • DialogControl | None –

    The closed dialog instance if one was found, otherwise None.

remove #

remove(*controls: Control) -> None

Removes specific controls from page.controls list.

remove_at #

remove_at(index: int) -> None

Remove controls from page.controls list at specific index.

scroll_to #

scroll_to(
    offset: Number | None = None,
    delta: Number | None = None,
    scroll_key: str
    | int
    | float
    | bool
    | ScrollKey
    | None = None,
    duration: DurationValue | None = None,
    curve: AnimationCurve | None = None,
) -> None

Moves scroll position to either absolute offset, relative delta or jump to the control with specified scroll_key.

See Column.scroll_to() for method details and examples.

show_dialog #

show_dialog(dialog: DialogControl) -> None

Displays a dialog and manages its dismissal lifecycle.

This method adds the specified dialog to the active dialog stack and renders it on the page. If the dialog is already open, an exception is raised. The on_dismiss handler of the dialog is temporarily wrapped to ensure the dialog is removed from the stack and its dismissal event is triggered appropriately.

Parameters:

  • dialog (DialogControl) –

    The dialog instance to display. Must not already be open.

Raises:

  • Exception –

    If the specified dialog is already open.

take_screenshot #

take_screenshot(
    pixel_ratio: Number | None = None,
    delay: DurationValue | None = None,
) -> bytes

Captures a screenshot of the entire page with overlays.

Parameters:

  • pixel_ratio (Number | None, default: None ) –

    A pixel ratio of the captured screenshot. If None, device-specific pixel ratio will be used.

  • delay (DurationValue | None, default: None ) –

    A delay before taking a screenshot. The delay will be 20 milliseconds if not specified.

Returns:

  • bytes –

    Screenshot in PNG format.

update #

update(*controls) -> None