Skip to content

Lottie

Lottie #

Bases: ConstrainedControl

Displays lottie animations.

animate: bool = True #

Whether the animation should be played automatically.

Defaults to True.

background_loading: Optional[bool] = None #

Whether the animation should be loaded in the background.

enable_layers_opacity: bool = False #

Whether to enable layer-level opacity.

Defaults to False.

enable_merge_paths: bool = False #

Whether to enable merge path support.

Defaults to False.

error_content: Optional[ft.Control] = None #

A control to display when an error occurs while loading the Lottie animation.

For more information on the error, see on_error.

filter_quality: ft.FilterQuality = ft.FilterQuality.LOW #

The quality of the image layer.

Defaults to FilterQuality.LOW.

fit: Optional[ft.ImageFit] = None #

Defines how to inscribe the Lottie composition into the space allocated during layout.

Value is of type ImageFit.

headers: Optional[Dict[str, str]] = None #

Headers for network requests.

on_error: ft.OptionalControlEventCallable = None #

Fires when an error occurs while loading the Lottie animation.

The data property of the event handler argument contains information on the error.

repeat: bool = True #

Whether the animation should repeat in a loop. Has no effect if animate is False.

Defaults to True.

reverse: bool = False #

Whether the animation should be played in reverse (from start to end and then continuously from end to start). Has no effect if animate or repeat is False.

Defaults to False.

src: Optional[str] = None #

The source of the Lottie file. Can be a URL or a local asset file.

src_base64: Optional[str] = None #

The base64 encoded string of the Lottie file. Either this or src must be provided. If both are provided, src_base64 will be prioritized/used.