.. _stdlib_ui_vertical_layout_component:

================
UIVerticalLayout
================


+++++++
Classes
+++++++

.. _struct-ui_vertical_layout_component-UIVerticalLayout:

.. das:attribute:: UIVerticalLayout : Component

.. note:: ``UIFrame``  component is automatically added to the node if it is not already present

This component arranges node's children vertically using specified ``spacing``, ``padding`` and ``alignment``.

If child node doesn't have ``UIFrame`` component, it won't participate in layouting.

.. note:: To work properly, ``UICanvas`` component is required in one of the parent nodes.

:Fields: * **alignment** :  :ref:`LayoutAlignment <enum-ui_layout_base-LayoutAlignment>`  - Alignment of the layout within the parent frame. Default is ``TopLeft``.

         * **spacing** : float - Spacing between children.

         * **padding** : float4 - Padding in pixels, `float4(left, top, right, bottom)`.

         * **childForceExpandWidth** : bool - If true, child frames will expand to fill the available width.

         * **childForceExpandHeight** : bool - If true, last child frame will expand to fill the available height.


.. _function-ui_vertical_layout_component_UIVerticalLayout_rq_layout_UIVerticalLayout:

.. das:function:: UIVerticalLayout.layout()

Applies vertical layouting to the children of the node.

.. note::
    This function is called automatically every frame.

.. _function-ui_vertical_layout_component_UIVerticalLayout_rq_apply_UIVerticalLayout_array_ls_NodeId_gr__hh_:

.. das:function:: UIVerticalLayout.apply(childrenNodes: array<NodeId>#)

Applies vertical layouting to the given children.

:Arguments: * **childrenNodes** : array< :ref:`NodeId <handle-public_scene-NodeId>` >#