KivyToast#
Implementation of toasts for desktop.from kivy.lang import Builder
from kivymd.app import MDApp
from kivymd.toast import toast
KV = '''
MDScreen:
MDTopAppBar:
title: 'Test Toast'
pos_hint: {'top': 1}
left_action_items: [['menu', lambda x: x]]
MDRaisedButton:
text: 'TEST KIVY TOAST'
pos_hint: {'center_x': .5, 'center_y': .5}
on_release: app.show_toast()
'''
class Test(MDApp):
def show_toast(self):
'''Displays a toast on the screen.'''
toast('Test Kivy Toast')
def build(self):
return Builder.load_string(KV)
Test().run()
API - kivymd.toast.kivytoast.kivytoast
#
- class kivymd.toast.kivytoast.kivytoast.Toast(**kwargs)#
ModalView class. See module documentation for more information.
- Events:
- on_pre_open:
Fired before the ModalView is opened. When this event is fired ModalView is not yet added to window.
- on_open:
Fired when the ModalView is opened.
- on_pre_dismiss:
Fired before the ModalView is closed.
- on_dismiss:
Fired when the ModalView is closed. If the callback returns True, the dismiss will be canceled.
Changed in version 1.11.0: Added events on_pre_open and on_pre_dismiss.
Changed in version 2.0.0: Added property ‘overlay_color’.
Changed in version 2.1.0: Marked attach_to property as deprecated.
- duration#
The amount of time (in seconds) that the toast is visible on the screen.
duration
is anNumericProperty
and defaults to 2.5.
- label_check_texture_size(self, instance_label: Label, texture_size: List[int])#
Resizes the text if the text texture is larger than the screen size. Sets the size of the toast according to the texture size of the toast text.
- on_open(self)#
Default open event handler.
- fade_in(self)#
Animation of opening toast on the screen.
- fade_out(self, *args)#
Animation of hiding toast on the screen.
- on_touch_down(self, touch)#
touch down event handler.
- kivymd.toast.kivytoast.kivytoast.toast(text: str = '', background: list = None, duration: float = 2.5) None #
Displays a toast.
- Parameters:
text – text to be displayed in the toast;
duration – the amount of time (in seconds) that the toast is visible on the screen
background – toast background color in
rgba
format;