One Widget to Adapt Them All and to The Librem 5 Port Them

In my previous article I shared my plans to help porting existing GTK+ applications to Purism’s upcoming Librem 5 phone without having to fork them. This article will present the GTK+ widget I developed for Purism to make this happen.

For more information on what Purism is working on for the Librem 5, please check Nicole Faerber’s latest article.

C’est pas sorcier

The underlying idea is to allow applications to dynamically switch between the two main GNOME application layouts: a row of panels — each panel being the view of an element from the previous one — and a stack of panels. The goal isn’t to changes applications using the stack paradigm but the ones using the row one, allowing them to reach smaller sizes and to be usable on constrained sizes while keeping their initial paradigm and design when the screen space is sufficient. The development cost to port the applications to this adaptive design should be as low as possible.

To achieve that, I wrote a GTK+ widget which acts similarly to a GtkBox when there is plenty of space for its children, but which adapts automatically and acts similarly to a GtkStack when there isn’t, displaying only one of its children. I called this widget HdyStackableBox and it is being developed for the libhandy library.

The widget’s minimum size is the minimum size of its visible child, matching the minimum size of a GtkStack. The widget’s natural size is the sum of the natural sizes of its children, matching size of a GtkBox.

The threshold below which the widget will turn into a stack is the sum of the natural sizes of its children — hence, when allocated less than its natural size the widget will turn into a stack. In box mode, the minimum size allocated to the children is their natural size, combined to the previously defined threshold this allows a collapsing priority property to naturally emerge as, when nesting HdyStackableBoxes, the wrapping one will collapse into a stack before the nested one. This is what I consider the biggest feature of this widget: this widget offers an adaptive behavior with no magic number involved.

Features of HdyStackableBox

HdyStackableBox is still in development, here is a list of already implemented features.

• Mode: box or stack.
• Adaptive design.
• Box homogeneity.
• Stack homogeneity.
• Mode transition:
  • None and slide animations.
  • Its duration is settable up to 250ms (like GtkRevealer).
• Child transition:
  • None animation.
  • Its duration is settable up to 200ms (like GtkStack).
• Named children.
• Unlimited children.

Here is a list of features that may or may not be implemented later.

• Draw on its own windows: the animations currently causes the widget to draw out of its allocated space.
• Mode transition: slide over animation, similarly to hiding the left panel of DzlBin.
• Child transition: slide animation.
• Orientation: this is partially implemented.
• Text direction: right-to-left languages should be supported.

Gimme! Gimme! Gimme!

The code is currently hosted at my fork of libhandy. You can test the widget by cloning the repo in GNOME Builder, moving to the wip/aplazas/stackablebox branch, building and running the project.

To test the widget in real world applications, I quickly tested it on GNOME Contacts. It is mostly ported and should work just fine, if not don’t hesitate to report any strange behavior to me but only regarding the adaptive port.

I also tested it on Geary, there is no navigation implemented yet but it’s a good test case of a complex UI with a HdyStackableBox nested into another.

Sorry for the graphical glitches, I suspect they are caused by a mix of out-of-bound drawings and improper/missing resizing and redraw queries, they will be fixed. You can test these by yourself by cloning, building and running these branches in GNOME Builder.

• Contacts: https://gitlab.gnome.org/aplazas/gnome-contacts/tree/wip/aplazas/stackablebox.
• Geary: https://gitlab.gnome.org/aplazas/geary/tree/wip/aplazas/stackablebox.

Keep in mind that my libhandy, GNOME Contacts and Geary forks are expected to disappear at some point in the future, and that I don’t guaranty their quality as this is all in development.

/* TODO */

As you can see in the list of unimplemented features and in the videos, there is still a lot to do, polishing the widget to make it featureful and bug free will take time, probably a few more weeks of focused development. In the meantime, feedback from designers on what this widget could be used for and — perhaps more importantly — what it shouldn’t be used for is more than welcome!

Once ready, what about turning it into GtkStackableBox? That would help its adoption by important applications like Settings, which probably don’t want an extra dependency just for a widget but which could then work on the Librem 5 without yet another major redesign.