sepal_ui.sepalwidgets.btn.Btn

class sepal_ui.sepalwidgets.btn.Btn(**kwargs)

Custom process Btn filled with the provided text.

The color will be defaulted to ‘primary’ and can be changed afterward according to your need.

Parameters:

• msg (Unicode) – the text to display in the btn

• gliph (Unicode) – the full name of any mdi/fa icon

• text – the text to display in the btn

• icon – the full name of any mdi/fa icon

• kwargs (dict, optional) – any parameters from v.Btn. if set, ‘children’ will be overwritten.

Deprecated since version 2.13: text and icon will be replaced by msg and gliph to avoid duplicating ipyvuetify trait.

Deprecated since version 2.14: Btn is not using a default msg anymor`.

Attributes

gliph	the name of the icon
msg	the text of the btn
v_icon	the icon in the btn

Methods

__init__	Custom process Btn filled with the provided text.
set_icon	Set a new icon.
toggle_loading	Jump between two states : disabled and loading - enabled and not loading.

Btn.__init__(msg='', gliph='', **kwargs)

Custom process Btn filled with the provided text.

The color will be defaulted to ‘primary’ and can be changed afterward according to your need.

Parameters:

• msg (str) – the text to display in the btn

• gliph (str) – the full name of any mdi/fa icon

• text – the text to display in the btn

• icon – the full name of any mdi/fa icon

• kwargs (dict, optional) – any parameters from v.Btn. if set, ‘children’ will be overwritten.

Return type:

None

Deprecated since version 2.13: text and icon will be replaced by msg and gliph to avoid duplicating ipyvuetify trait.

Deprecated since version 2.14: Btn is not using a default msg anymor`.

Btn.set_icon(icon='')

Set a new icon. If the icon is set to “”, then it’s hidden.

Parameters:

icon (str) – the full name of a mdi/fa icon

Return type:

Self

Deprecated since version 2.14: Replace by the private _set_gliph

Btn.toggle_loading()

Jump between two states : disabled and loading - enabled and not loading.

Return type:

Self