View

View is the top most container for all other controls.

A root view is automatically created when a new user session started. From layout perspective the View represents a Column control, so it has a similar behavior and shares same properties.

Inherits: ScrollableControl, LayoutControl

Properties

• appbar - An AppBar control to display at the top of the Page.
• bgcolor - Background color of the view.
• bottom_appbar - A BottomAppBar control to display at the bottom of the Page.
• can_pop - Whether the view can be popped.
• controls - A list of controls to display.
• decoration - The background decoration.
• drawer - A NavigationDrawer control to display as a panel sliding from the start edge of the view.
• end_drawer - A NavigationDrawer control to display as a panel sliding from the end edge of the view.
• floating_action_button - A FloatingActionButton control to display on top of Page content.
• floating_action_button_location - Describes position of floating_action_button
• foreground_decoration - The foreground decoration.
• fullscreen_dialog - If True, the view is a fullscreen modal dialog.
• horizontal_alignment - How the child Controls should be placed horizontally.
• navigation_bar - A navigation bar (NavigationBar or CupertinoNavigationBar) control to display at the bottom of the Page.
• padding - A space between page contents and its edges.
• route - View's route - not currently used by Flet framework, but can be used in a user program to update flet.Page.route when a view popped.
• services - A list of Service controls associated with this view.
• spacing - The vertical spacing between controls on the Page.
• vertical_alignment - Defines how the child controls should be placed vertically.

Events

• on_confirm_pop - An event handler that is called when the view is about to be popped.

Methods

• close_drawer - Close the drawer.
• close_end_drawer - Close the end drawer.
• confirm_pop - Resolves a pending pop-confirmation request for this view.
• show_drawer - Show the drawer.
• show_end_drawer - Show the end drawer.

Properties

buildappbarclass-attributeinstance-attribute

appbar: Optional[Union[AppBar, CupertinoAppBar]] = None

An AppBar control to display at the top of the Page.

buildbgcolorclass-attributeinstance-attribute

bgcolor: Optional[ColorValue] = None

Background color of the view.

buildbottom_appbarclass-attributeinstance-attribute

bottom_appbar: Optional[BottomAppBar] = None

A BottomAppBar control to display at the bottom of the Page.

buildcan_popclass-attributeinstance-attribute

can_pop: bool = True

Whether the view can be popped.

buildcontrolsclass-attributeinstance-attribute

controls: list[BaseControl] = field(default_factory=list)

A list of controls to display.

builddecorationclass-attributeinstance-attribute

decoration: Optional[BoxDecoration] = None

The background decoration.

builddrawerclass-attributeinstance-attribute

drawer: Optional[NavigationDrawer] = None

A NavigationDrawer control to display as a panel sliding from the start edge of the view.

buildend_drawerclass-attributeinstance-attribute

end_drawer: Optional[NavigationDrawer] = None

A NavigationDrawer control to display as a panel sliding from the end edge of the view.

buildfloating_action_buttonclass-attributeinstance-attribute

floating_action_button: Optional[FloatingActionButton] = None

A FloatingActionButton control to display on top of Page content.

buildfloating_action_button_locationclass-attributeinstance-attribute

floating_action_button_location: Optional[Union[FloatingActionButtonLocation, OffsetValue]] = None

Describes position of floating_action_button

buildforeground_decorationclass-attributeinstance-attribute

foreground_decoration: Optional[BoxDecoration] = None

The foreground decoration.

buildfullscreen_dialogclass-attributeinstance-attribute

fullscreen_dialog: bool = False

If True, the view is a fullscreen modal dialog.

buildhorizontal_alignmentclass-attributeinstance-attribute

horizontal_alignment: CrossAxisAlignment = CrossAxisAlignment.START

How the child Controls should be placed horizontally.

buildnavigation_barclass-attributeinstance-attribute

navigation_bar: Union[NavigationBar, CupertinoNavigationBar, None] = None

A navigation bar (NavigationBar or CupertinoNavigationBar) control to display at the bottom of the Page.

buildpaddingclass-attributeinstance-attribute

padding: Optional[PaddingValue] = field(default_factory=(lambda: Padding.all(10)))

A space between page contents and its edges.

buildrouteclass-attributeinstance-attribute

route: str = field(default_factory=(lambda: '/'))

View's route - not currently used by Flet framework, but can be used in a user program to update flet.Page.route when a view popped.

buildservicesclass-attributeinstance-attribute

services: list[Service] = field(default_factory=list, metadata={'skip': True})

A list of Service controls associated with this view.

buildspacingclass-attributeinstance-attribute

spacing: Number = 10

The vertical spacing between controls on the Page.

Note

Has effect only when vertical_alignment is set to flet.MainAxisAlignment.START, flet.MainAxisAlignment.END, or flet.MainAxisAlignment.CENTER.

buildvertical_alignmentclass-attributeinstance-attribute

vertical_alignment: MainAxisAlignment = MainAxisAlignment.START

Defines how the child controls should be placed vertically.

Events

bolton_confirm_popclass-attributeinstance-attribute

on_confirm_pop: Optional[ControlEventHandler[View]] = None

An event handler that is called when the view is about to be popped. You can use this event to confirm or cancel the pop action by calling confirm_pop method.

Methods

deployed_codeclose_drawerasync

close_drawer()

Close the drawer.

deployed_codeclose_end_drawerasync

close_end_drawer()

Close the end drawer.

deployed_codeconfirm_popasync

confirm_pop(should_pop: bool)

Resolves a pending pop-confirmation request for this view.

Call this from on_confirm_pop to allow or cancel the current back-navigation attempt.

Parameters:

• should_pop (bool) - True to proceed with popping this view, False to keep the view on the navigation stack.

Notes

• This method only has effect while a pop confirmation is pending.
• If not called, the frontend confirmation wait times out and the pop is canceled.

deployed_codeshow_drawerasync

show_drawer()

Show the drawer.

Raises:

• ValueError - If no drawer is defined.

deployed_codeshow_end_drawerasync

show_end_drawer()

Show the end drawer.

Raises:

• ValueError - If no end_drawer is defined.