Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
flet / controls / material / elevated_button.py
Size: Mime:
import asyncio
from typing import Optional

from flet.controls.adaptive_control import AdaptiveControl
from flet.controls.base_control import control
from flet.controls.buttons import ButtonStyle
from flet.controls.constrained_control import ConstrainedControl
from flet.controls.control import Control
from flet.controls.types import (
    ClipBehavior,
    IconValueOrControl,
    Number,
    OptionalColorValue,
    OptionalControlEventCallable,
    StrOrControl,
    UrlTarget,
)

__all__ = ["ElevatedButton"]


@control("ElevatedButton")
class ElevatedButton(ConstrainedControl, AdaptiveControl):
    """
    Elevated buttons are essentially filled tonal buttons with a shadow. To prevent
    shadow creep, only use them when absolutely necessary, such as when the button
    requires visual separation from a patterned background.

    Online docs: https://flet.dev/docs/controls/elevatedbutton
    """

    content: Optional[StrOrControl] = None
    """
    A Control representing custom button content.
    """

    icon: Optional[IconValueOrControl] = None
    """
    Icon shown in the button.
    """

    icon_color: OptionalColorValue = None
    """
    Icon [color](https://flet.dev/docs/reference/colors).
    """

    color: OptionalColorValue = None
    """
    Button's text [color](https://flet.dev/docs/reference/colors). If both `color` and 
    `style.color` are provided, `color` value will be used.
    """

    bgcolor: OptionalColorValue = None
    """
    Button's background [color](https://flet.dev/docs/reference/colors). If both 
    `bgcolor` and `style.bgcolor` are provided, `bgcolor` value will be used.
    """

    elevation: Number = 1
    """
    Button's elevation. If both `elevation` and `style.elevation` are provided, 
    `elevation` value will be used.
    """

    style: Optional[ButtonStyle] = None
    """
    The value is an instance of [`ButtonStyle`](https://flet.dev/docs/reference/types/buttonstyle) 
    class. 
    """

    autofocus: Optional[bool] = None
    """
    True if the control will be selected as the initial focus. If there is more than 
    one control on a page with autofocus set, then the first one added to the page will 
    get focus.
    """

    clip_behavior: Optional[ClipBehavior] = None
    """
    The content will be clipped (or not) according to this option.

    Value is of type [`ClipBehavior`](https://flet.dev/docs/reference/types/clipbehavior) 
    and defaults to `ClipBehavior.NONE`.
    """

    url: Optional[str] = None
    """
    The URL to open when the button is clicked. If registered, `on_click` event is 
    fired after that.
    """

    url_target: Optional[UrlTarget] = None
    """
    Where to open URL in the web mode.

    Value is of type [`UrlTarget`](https://flet.dev/docs/reference/types/urltarget) and 
    defaults to `UrlTarget.BLANK`.
    """

    on_click: OptionalControlEventCallable = None
    """
    Fires when a user clicks the button.
    """

    on_long_press: OptionalControlEventCallable = None
    """
    Fires when the button is long-pressed.
    """

    on_hover: OptionalControlEventCallable = None
    """
    Fires when a mouse pointer enters or exists the button response area. `data` 
    property of event object contains `true` (string) when cursor enters and `false` 
    when it exits.

    ```python
    import flet as ft

    def main(page: ft.Page):
        def on_hover(e):
            e.control.bgcolor = "orange" if e.data == "true" else "yellow"
            e.control.update()

        page.add(
            ft.ElevatedButton(
                "I'm changing color on hover", bgcolor="yellow", on_hover=on_hover
            )
        )

    ft.run(main)
    ```
    """

    on_focus: OptionalControlEventCallable = None
    """
    Fires when the control has received focus.
    """

    on_blur: OptionalControlEventCallable = None
    """
    Fires when the control has lost focus.
    """

    def before_update(self):
        super().before_update()
        assert (
            self.icon
            or isinstance(self.content, str)
            or (isinstance(self.content, Control) and self.content.visible)
        ), "at least icon or content (string or visible Control) must be provided"

    async def focus_async(self):
        await self._invoke_method_async("focus")

    def focus(self):
        asyncio.create_task(self.focus_async())