:github_url: https://github.com/kivymd/KivyMD/blob/master/kivymd/uix/behaviors/state_layer_behavior.py

State Layer
===========

.. py:module:: kivymd.uix.behaviors.state_layer_behavior

.. autoapi-nested-parse::

   Behaviors/State Layer
   =====================

   .. seealso::

      `Material Design spec, State layers <https://m3.material.io/foundations/interaction/states/state-layers>`_


API - :mod:`kivymd.uix.behaviors.state_layer_behavior`
------------------------------------------------------

.. py:class:: StateLayerBehavior(*args, **kwargs)




   Focus behavior class.

   :Events:
       :attr:`on_enter`
           Fired when mouse enters the bbox of the widget AND the widget is
           visible.
       :attr:`on_leave`
           Fired when the mouse exits the widget AND the widget is visible.

   For more information, see in the
   :class:`~kivymd.uix.behavior.HoverBehavior` class documentation.

   .. versionadded:: 2.0.0

   .. py:attribute:: state_layer_color

      The color of the layer state.

      :attr:`state_layer_color` is an :class:`~kivy.properties.ColorProperty`
      and defaults to `[0, 0, 0, 0]`.


   .. py:attribute:: state_hover

      The transparency level of the layer as a percentage when hovering.

      :attr:`state_hover` is an :class:`~kivy.properties.NumericProperty`
      and defaults to `0.08`.


   .. py:attribute:: state_press

      The transparency level of the layer as a percentage when pressed.

      :attr:`state_press` is an :class:`~kivy.properties.NumericProperty`
      and defaults to `0.12`.


   .. py:attribute:: state_drag

      The transparency level of the layer as a percentage when dragged.

      :attr:`state_drag` is an :class:`~kivy.properties.NumericProperty`
      and defaults to `0.16`.


   .. py:attribute:: icon_button_filled_opacity_value_disabled_container

      

   .. py:attribute:: icon_button_filled_opacity_value_disabled_icon

      

   .. py:attribute:: icon_button_tonal_opacity_value_disabled_container

      

   .. py:attribute:: icon_button_tonal_opacity_value_disabled_icon

      

   .. py:attribute:: icon_button_outlined_opacity_value_disabled_container

      

   .. py:attribute:: icon_button_outlined_opacity_value_disabled_line

      

   .. py:attribute:: icon_button_outlined_opacity_value_disabled_icon

      

   .. py:attribute:: icon_button_standard_opacity_value_disabled_icon

      

   .. py:attribute:: fab_button_opacity_value_disabled_container

      

   .. py:attribute:: fab_button_opacity_value_disabled_icon

      

   .. py:attribute:: button_filled_opacity_value_disabled_container

      

   .. py:attribute:: button_filled_opacity_value_disabled_icon

      

   .. py:attribute:: button_filled_opacity_value_disabled_text

      

   .. py:attribute:: button_tonal_opacity_value_disabled_container

      

   .. py:attribute:: button_tonal_opacity_value_disabled_icon

      

   .. py:attribute:: button_tonal_opacity_value_disabled_text

      

   .. py:attribute:: button_outlined_opacity_value_disabled_container

      

   .. py:attribute:: button_outlined_opacity_value_disabled_line

      

   .. py:attribute:: button_outlined_opacity_value_disabled_icon

      

   .. py:attribute:: button_outlined_opacity_value_disabled_text

      

   .. py:attribute:: button_elevated_opacity_value_disabled_container

      

   .. py:attribute:: button_elevated_opacity_value_disabled_icon

      

   .. py:attribute:: button_elevated_opacity_value_disabled_text

      

   .. py:attribute:: button_text_opacity_value_disabled_icon

      

   .. py:attribute:: button_text_opacity_value_disabled_text

      

   .. py:attribute:: label_opacity_value_disabled_text

      

   .. py:attribute:: card_filled_opacity_value_disabled_state_container

      

   .. py:attribute:: card_outlined_opacity_value_disabled_state_container

      

   .. py:attribute:: card_opacity_value_disabled_state_elevated_container

      

   .. py:attribute:: segmented_button_opacity_value_disabled_container

      

   .. py:attribute:: segmented_button_opacity_value_disabled_container_active

      

   .. py:attribute:: segmented_button_opacity_value_disabled_line

      

   .. py:attribute:: segmented_button_opacity_value_disabled_icon

      

   .. py:attribute:: segmented_button_opacity_value_disabled_text

      

   .. py:attribute:: chip_opacity_value_disabled_container

      

   .. py:attribute:: chip_opacity_value_disabled_text

      

   .. py:attribute:: chip_opacity_value_disabled_icon

      

   .. py:attribute:: switch_opacity_value_disabled_line

      

   .. py:attribute:: switch_opacity_value_disabled_container

      

   .. py:attribute:: switch_thumb_opacity_value_disabled_container

      

   .. py:attribute:: switch_opacity_value_disabled_icon

      

   .. py:attribute:: checkbox_opacity_value_disabled_container

      

   .. py:attribute:: list_opacity_value_disabled_container

      

   .. py:attribute:: list_opacity_value_disabled_leading_avatar

      

   .. py:attribute:: text_field_filled_opacity_value_disabled_state_container

      

   .. py:attribute:: text_field_outlined_opacity_value_disabled_state_container

      

   .. py:attribute:: text_field_opacity_value_disabled_max_length_label

      

   .. py:attribute:: text_field_opacity_value_disabled_helper_text_label

      

   .. py:attribute:: text_field_opacity_value_disabled_hint_text_label

      

   .. py:attribute:: text_field_opacity_value_disabled_leading_icon

      

   .. py:attribute:: text_field_opacity_value_disabled_trailing_icon

      

   .. py:attribute:: text_field_opacity_value_disabled_line

      

   .. py:method:: set_properties_widget() -> None

      Fired `on_release/on_press/on_enter/on_leave` events.


   .. py:method:: on_disabled(instance, value) -> None

      Fired when the `disabled` value changes.


   .. py:method:: on_enter() -> None

      Fired when mouse enter the bbox of the widget.


   .. py:method:: on_leave() -> None

      Fired when the mouse goes outside the widget border.