WrapperManager - Quickshell.Widgets

WrapperManager: QtObject

import Quickshell.Widgets

WrapperManager determines which child of an Item should be its visual child, and exposes it for further operations. See MarginWrapperManager for a subclass that implements automatic sizing and margins.

Using wrapper types

WrapperManager based types have a single visual child item. You can specify the child item using the default property, or by setting the child property. You must use the child property if the widget has more than one Item based child.

Example using the default property

WrapperWidget { // a widget that uses WrapperManager
  // Putting the item inline uses the default property of WrapperWidget.
  Text { text: "Hello" }

  // Scope does not extend Item, so it can be placed in the
  // default property without issue.
  Scope {}
}

Example using the child property

WrapperWidget {
  Text {
    id: text
    text: "Hello"
  }

  Text {
    id: otherText
    text: "Other Text"
  }

  // Both text and otherText extend Item, so one must be specified.
  child: text
}

See child for more details on how the child property can be used.

Implementing wrapper types

In addition to the bundled wrapper types, you can make your own using WrapperManager. To implement a wrapper, create a WrapperManager inside your wrapper component ‘s default property, then alias a new property to the WrapperManager’s child property.

Example

Item { // your wrapper component
  WrapperManager { id: wrapperManager }

  // Allows consumers of your wrapper component to use the child property.
  property alias child: wrapperManager.child

  // The rest of your component logic. You can use
  // `wrapperManager.child` or `this.child` to refer to the selected child.
}