DragTarget

Examples

See these.

DragTarget

Bases: Control

A control that completes drag operation when a Draggable control is dropped.

When a Draggable is dragged on top of a DragTarget, the DragTarget is asked whether it will accept the data the Draggable is carrying. The DragTarget will accept incoming drag if it belongs to the same group as Draggable. If the user does drop the Draggable on top of the DragTarget (and the DragTarget has indicated that it will accept the Draggable's data), then the DragTarget is asked to accept the Draggable's data.

RAISES	DESCRIPTION
AssertionError	If content is not visible.

badge

badge: BadgeValue | None = None

A badge to show on top of this control.

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.

Dimensions

Breakpoint	Dimension
xs	<576px
sm	≥576px
md	≥768px
lg	≥992px
xl	≥1200px
xxl	≥1400px

content

content: Control

The content of this control.

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.

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.

group

group: str = 'default'

The group this target belongs to.

Note

For a DragTarget to accept an incoming drop from a Draggable, they must both be in the same group.

key

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

on_accept

on_accept: EventHandler[DragTargetEvent] | None = None

Called when the user does drop an acceptable (same group) draggable on this target.

Use page.get_control(e.src_id) to retrieve Control reference by its ID.

on_leave

on_leave: EventHandler[DragTargetLeaveEvent] | None = None

Called when a draggable leaves this target.

on_move

on_move: EventHandler[DragTargetEvent] | None = None

Called when a draggable moves within this target.

on_will_accept

on_will_accept: EventHandler[DragWillAcceptEvent] | None = (
    None
)

Called when a draggable is dragged on this target.

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 | PageView | None

The page (of type Page or PageView) 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.

rtl

rtl: bool = False

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

tooltip

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

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.

before_event

before_event(e: ControlEvent)

before_update

before_update()

clean

clean() -> None

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

update

update() -> None

will_unmount

will_unmount()