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

Divider
=======

.. py:module:: kivymd.uix.divider.divider

.. autoapi-nested-parse::

   Components/Divider
   ==================

   .. versionadded:: 2.0.0

   .. seealso::

       `Material Design 3 spec, Divider <https://m3.material.io/components/divider/overview>`_

   .. rubric:: Dividers are thin lines that group content in lists or other containers.

   .. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/divider.png
       :align: center

   - Make dividers visible but not bold
   - Only use dividers if items can’t be grouped with open space
   - Use dividers to group things, not separate individual items

   `KivyMD` provides the following bar positions for use:

   - HorizontalDivider_
   - VerticalDivider_

   .. HorizontalDivider:

   HorizontalDivider
   -----------------

   Dividers are one way to visually group components and create hierarchy.
   They can also be used to imply nested parent/child relationships.

   .. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/divider-horizontal-desc.png
       :align: center

   .. tabs::

       .. tab:: Declarative python style with KV

           .. code-block:: python

               from kivy.lang import Builder

               from kivymd.app import MDApp

               KV = '''
               MDScreen:
                   md_bg_color: self.theme_cls.backgroundColor

                   MDDivider:
                       size_hint_x: .5
                       theme_divider_color: "Custom"
                       color: self.theme_cls.onBackgroundColor
                       pos_hint: {'center_x': .5, 'center_y': .5}
               '''


               class Example(MDApp):
                   def build(self):
                       self.theme_cls.theme_style = "Dark"
                       return Builder.load_string(KV)


               Example().run()

       .. tab:: Declarative python style

           .. code-block:: python

               from kivymd.app import MDApp
               from kivymd.uix.divider import MDDivider
               from kivymd.uix.screen import MDScreen


               class Example(MDApp):
                   def build(self):
                       self.theme_cls.theme_style = "Dark"
                       return (
                           MDScreen(
                               MDDivider(
                                   size_hint_x=0.5,
                                   pos_hint={'center_x': 0.5, 'center_y': 0.5},
                                   theme_divider_color="Custom",
                                   color=self.theme_cls.onBackgroundColor,
                               ),
                               md_bg_color=self.theme_cls.backgroundColor
                           )
                       )


               Example().run()

   .. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/divider-horizontal.png
       :align: center

   .. VerticalDivider:

   VerticalDivider
   ---------------

   A vertical divider can be used to arrange content on a larger screen, such as
   separating paragraph text from video or imagery media.

   .. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/divider-vertical-desc.png
       :align: center

   .. tabs::

       .. tab:: Declarative style with KV

           .. code-block:: kv

               MDDivider:
                   size_hint_y: .5
                   orientation: "vertical"

       .. tab:: Declarative python style

           .. code-block:: python

               MDDivider(
                   orientation="vertical",
                   size_hint_y=0.5,
               )

   .. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/divider-vertical.png
       :align: center

   API break
   =========

   1.2.0 version
   -------------

   .. code-block:: kv

       MDSeparator:
           [...]

   2.0.0 version
   -------------

   .. code-block:: kv

       MDDivider:
           [...]


API - :mod:`kivymd.uix.divider.divider`
---------------------------------------

.. py:class:: MDDivider(**kwargs)




   A divider line.

   .. versionadded:: 2.0.0

   For more information, see in the
   :class:`~kivymd.theming.ThemableBehavior` and
   :class:`~kivy.uix.boxlayout.BoxLayout` classes documentation.

   .. py:attribute:: color

      Divider color in (r, g, b, a) or string format.

      :attr:`color` is a :class:`~kivy.properties.ColorProperty`
      and defaults to `None`.


   .. py:attribute:: divider_width

      Divider width.

      :attr:`divider_width` is an :class:`~kivy.properties.NumericProperty`
      and defaults to `dp(1)`.


   .. py:method:: on_orientation(*args) -> None

      Fired when the values of :attr:`orientation` change.