DataRow2
DataRow2
#
Bases: DataRow
Extends DataRow
.
Adds row-level tap
events. There are also on_secondary_tap
and on_secondary_tap_down
,
which are not available in DataCell
s and can be useful in desktop settings to handle right-click actions.
cells: list[DataCell] = field(default_factory=list)
#
The data for this row - a list of DataCell
controls.
There must be exactly as many cells as there are columns in the table.
col: ResponsiveNumber = 12
#
If a parent of the control is ResponsiveRow, col
property is used to determine
how many virtual columns of a screen the control will span.
Can be a number or a dictionary configured to have a different value for specific
breakpoints, for example col={"sm": 6}
. Breakpoints are named dimension ranges:
Breakpoint | Dimension |
---|---|
xs | <576px |
sm | ≥576px |
md | ≥768px |
lg | ≥992px |
xl | ≥1200px |
xxl | ≥1400px |
If col
property is not specified, it spans the maximum number of columns (12).
color: ControlStateValue[ColorValue] | None = None
#
The color for the row.
By default, the color is transparent unless selected. Selected rows has a grey translucent color.
The effective color can depend on the ControlState
state, if the row is selected, pressed, hovered, focused, disabled or enabled. The
color is painted as an overlay to the row. To make sure that the row's InkWell is
visible (when pressed, hovered and focused), it is recommended to use a translucent
color.
data: Any = skip_field()
#
Arbitrary data of any type that can be attached to a control.
decoration: ft.BoxDecoration | None = None
#
Decoration to be applied to the row.
Overrides divider_thickness
.
disabled: bool = False
#
Every control has disabled
property which is False
by default - control and all
its children are enabled.
disabled
property is mostly used with data entry controls like TextField
,
Dropdown
, Checkbox
, buttons.
However, disabled
could be set to a parent control and its value will be
propagated down to all children recursively.
For example, if you have a form with multiple entry controls you can disable them all together by disabling container:
expand: bool | int | None = None
#
When a child Control is placed into a Column
or a Row
you can "expand" it to fill the
available space.
expand
property could be a boolean value (True
- expand control to fill all
available space) or an integer - an "expand factor" specifying how to divide a free
space with other expanded child controls.
For more information and examples about expand
property see "Expanding children"
sections in Column
or
Row
.
Here is an example of expand being used in action for both Column
and Row
:
import flet as ft
def main(page: ft.Page):
page.spacing = 0
page.padding = 0
page.add(
ft.Column(
controls=[
ft.Row(
[
ft.Card(
content=ft.Text("Card_1"),
color=ft.Colors.ORANGE_300,
expand=True,
height=page.height,
margin=0,
),
ft.Card(
content=ft.Text("Card_2"),
color=ft.Colors.GREEN_100,
expand=True,
height=page.height,
margin=0,
),
],
expand=True,
spacing=0,
),
],
expand=True,
spacing=0,
),
)
ft.app(main)
expand_loose: bool | None = None
#
Effective only if expand
is True
.
If expand_loose
is True
, the child control of a
Column
or a Row
will be given the flexibility to expand to fill the available space in the main
axis (e.g., horizontally for a Row or vertically for a Column), but will not be
required to fill the available space.
The default value is False
.
Here is the example of Containers placed in Rows with expand_loose = True
:
import flet as ft
class Message(ft.Container):
def __init__(self, author, body):
super().__init__()
self.content = ft.Column(
controls=[
ft.Text(author, weight=ft.FontWeight.BOLD),
ft.Text(body),
],
)
self.border = ft.border.all(1, ft.Colors.BLACK)
self.border_radius = ft.border_radius.all(10)
self.bgcolor = ft.Colors.GREEN_200
self.padding = 10
self.expand = True
self.expand_loose = True
def main(page: ft.Page):
chat = ft.ListView(
padding=10,
spacing=10,
controls=[
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Hi, how are you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Hi I am good thanks, how about you?",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.START,
controls=[
Message(
author="John",
body="Lorem Ipsum is simply dummy text of the printing and
typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown
printer took a galley of type and scrambled it to make a
type specimen book.",
),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.END,
controls=[
Message(
author="Jake",
body="Thank you!",
),
],
),
],
)
page.window.width = 393
page.window.height = 600
page.window.always_on_top = False
page.add(chat)
ft.run(main)
key: str | int | float | bool | ValueKey | ScrollKey | None = None
#
on_double_tap: ft.OptionalControlEventHandler[DataRow2] = None
#
Fires when the row is double-tapped.
Ignored if the tapped cell has a tap
handler.
on_long_press: OptionalControlEventHandler[DataRow] = None
#
Called if the row is long-pressed.
If a DataCell
in the row has its DataCell.on_tap
, DataCell.on_double_tap
,
DataCell.on_long_press
, DataCell.on_tap_cancel
or DataCell.on_tap_down
callback defined, that callback behavior overrides the gesture behavior of the row
for that particular cell.
on_secondary_tap: ft.OptionalControlEventHandler[DataRow2] = None
#
Fires when the row is right-clicked (secondary tap).
Ignored if the tapped cell has a tap
handler.
on_secondary_tap_down: ft.OptionalControlEventHandler[DataRow2] = None
#
Fires when the row is right-clicked (secondary tap down).
Ignored if the tapped cell has a tap
handler.
on_select_changed: OptionalControlEventHandler[DataRow] = None
#
Called when the user selects or unselects a selectable row.
If this is not null, then the row is selectable. The current selection state of the row is given by selected.
If any row is selectable, then the table's heading row will have a checkbox that can be checked to select all selectable rows (and which is checked if all the rows are selected), and each subsequent row will have a checkbox to toggle just that row.
A row whose on_select_changed
callback is null is ignored for the purposes of
determining the state of the "all" checkbox, and its checkbox is disabled.
If a DataCell
in the row has its DataCell.on_tap
callback defined, that
callback behavior overrides the gesture behavior of the row for that particular
cell.
on_tap: ft.OptionalEventHandler[ft.TapEvent[DataRow2]] = None
#
Fires when the row is tapped.
Ignored if the tapped cell has a tap
handler.
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) and defaults to 1.0
.
page: Page | PageView | None
#
The page (of type Page
or PageView
) to which this control belongs to.
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
.
rtl: bool = False
#
True
to set text direction to right-to-left.
selected: bool = False
#
Whether the row is selected.
If on_select_changed
is non-null for any row in the table, then a checkbox is
shown at the start of each row. If the row is selected (True
), the checkbox will
be checked and the row will be highlighted.
Otherwise, the checkbox, if present, will not be checked.
specific_row_height: ft.Number | None = None
#
Specific row height.
Falls back to data_row_height
if not set.
tooltip: TooltipValue | None = None
#
The tooltip
property supports both strings
and Tooltip
objects.
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.