KDE API Reference

Contents

FormLayout QML Type

Import Statement: import org.kde.kirigami.layouts
Since: 2.3
Inherits:

Item

Properties

Detailed Description

This is the base class for Form layouts conforming to the Kirigami Human Interface Guidelines. The layout consists of two columns: the left column contains only right-aligned labels provided by a FormData attached property, the right column contains left-aligned child types.

Child types can be sectioned using an QtQuick.Item or Kirigami.Separator with a FormData attached property, see FormLayoutAttached::isSection for details.

Example usage:

import QtQuick.Controls as QQC2
import org.kde.kirigami as Kirigami

Kirigami.FormLayout {
   QQC2.TextField {
      Kirigami.FormData.label: "Label:"
   }
   Kirigami.Separator {
       Kirigami.FormData.label: "Section Title"
       Kirigami.FormData.isSection: true
   }
   QQC2.TextField {
      Kirigami.FormData.label: "Label:"
   }
   QQC2.TextField {
   }
}

See also FormData.

Property Documentation

twinFormLayouts : Item [since 5.53]

If for some implementation reason multiple FormLayouts have to appear on the same page, they can have each other in twinFormLayouts, so they will vertically align with each other perfectly

This property was introduced in 5.53.


wideMode : bool

This property tells whether the form layout is in wide mode.

If true, the layout will be optimized for a wide screen, such as a desktop machine (the labels will be on a left column, the fields on a right column beside it), if false (such as on a phone) everything is laid out in a single column.

By default this property automatically adjusts the layout if there is enough screen space.

Set this to true for a convergent design, set this to false for a mobile-only design.