Port Extensions to GNOME Shell 42

Metadata

Session Modes

TIP

See the Session Modes documentation for more details.

GNOME Shell 42 added support for the session-modes field in metadata.json.

"session-modes" value is array of strings with these possible values:

ValueDescription
gdmYour extension will be enabled in gdm login screen.
unlock-dialogYour extension will be enabled (or stays enabled) in unlock dialog.
userYour extension will be enabled (or stays enabled) when unlock is happening.

For example:

"session-modes":  [ "gdm", "unlock-dialog", "user" ],
1

Extension

TIP

There were no relevant to extension.js in GNOME 42.

Preferences

GNOME Shell 42 is using Adw.PreferencesWindow instead of Gtk.Window for extension preferences dialog. It means you can use Libadwaita widgets in your extension preferences window.

buildPrefsWidget()

Don't worry if you are new to Libadwaita. You can still use your old GTK4 UI without changing anything.

buildPrefsWidget() can return three output types (You can see how these types will be wrapped up):

  1. Adw.PreferencesPage

    Adw.PreferencesWindow
    └── Adw.PreferencesPage (returned value as Libadwaita Page)
    
    1
    2
  2. Adw.PreferencesGroup

    Adw.PreferencesWindow
    └── Adw.PreferencesPage
        └── Adw.PreferencesGroup (returned value as Libadwaita Preferences Group)
    
    1
    2
    3
  3. Gtk.Widget

    Adw.PreferencesWindow
    └── Adw.PreferencesPage
        └── Gtk.Widget (returned value as GTK4 Widget)
    
    1
    2
    3

fillPreferencesWindow()

fillPreferencesWindow() is a new function introduced in GNOME Shell 42 and you can use it to fill the preferences window (Adw.PreferencesWindow).

  • First parameter is Adw.PreferencesWindow.
  • The return type is void (don't need to return anything).
  • You should fill the window with at least one page.
  • fillPreferencesWindow() has higher priority to buildPrefsWidget(). It means if you declare both of them in prefs.js file, only fillPreferencesWindow() will be used.

For example, if you are using a template file like this:

<?xml version="1.0" encoding="UTF-8"?>
<interface>
  <object class="AdwPreferencesPage" id="my_page">
    <property name="name">my-page</property>
    <property name="title" translatable="yes">My Page</property>
    <property name="icon-name">folder-symbolic</property>
    <child>
      <object class="AdwPreferencesGroup" id="my_group">
        <property name="title" translatable="yes">My Group</property>
        <child>
          <object class="AdwActionRow" id="my_row">
            <property name="title" translatable="yes">My Switch</property>
            <property name="activatable-widget">my_switch</property>
            <child>
              <object class="GtkSwitch" id="my_switch">
                <property name="valign">center</property>
              </object>
            </child>
          </object>
        </child>
      </object>
    </child>
  </object>
</interface>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

You can add my_page to the preferences window like this:

const {Gtk} = imports.gi;

function fillPreferencesWindow(window) {
    let builder = Gtk.Builder.new();
    builder.add_from_file('PATH_TO_THE_TEMPLATE_FILE');
    let page = builder.get_object('my_page');
    window.add(page);
}
1
2
3
4
5
6
7
8

You can also import Libadwaita and use it directly like this:

const {Adw} = imports.gi;

function fillPreferencesWindow(window) {
    let page1 = Adw.PreferencesPage.new();
    page1.set_title('First Page');
    page1.set_name('first-page');
    page1.set_icon_name('folder-symbolic');

    let group1 = Adw.PreferencesGroup.new();
    group1.set_title('Group in first page');
    page1.add(group1);

    let page2 = Adw.PreferencesPage.new();
    page2.set_title('Second Page');
    page2.set_name('second-page');
    page2.set_icon_name('folder-pictures-symbolic');

    let group2 = Adw.PreferencesGroup.new();
    group2.set_title('Group in second page');
    page2.add(group2);

    window.add(page1);
    window.add(page2);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

You can learn about Libadwaita's widgets in gjs-docs.gnome.org/adw1open in new window.

Test Preferences Window in Dark and Light mode

While you opened and focused on preferences window:

  • Press Ctrl+Shift+I or Ctrl+Shift+D to open interactive debugging window.
  • Go to Adwaita tab.
  • Change Preferred Color Scheme.

You need to set enable-inspector-keybinding to true if the keybinding doesn't work:

gsettings set org.gtk.Settings.Debug enable-inspector-keybinding true
1

Resize Preferences Window

Preferences window no longer has a default size. Adw.PreferencesWindow can set the appropriate size by default.

Also fillPreferencesWindow() allows you to have access to the preferences window and you can resize it with set_default_size():

function fillPreferencesWindow(window) {
    window.set_default_size(800, 600);
    // ...
}
1
2
3
4

Enable Search in Preferences Window

Libadwaita has built-in search feature that you can use in preferences window and it can search through title and subtitle of Adw.PreferencesRow.

Search feature is disabled by default but you can enable it in preferences window with search-enabled property if you want:

function fillPreferencesWindow(window) {
    window.search_enabled = true;
    // ...
}
1
2
3
4

Header Bar

Gtk.Window.get_titlebar() and Gtk.Window.set_titlebar() are not supported in Libadwaita.

Gtk.ScrolledWindow

Adw.PreferencesPage has buit-in Gtk.ScrolledWindow. If you are using Gtk.ScrolledWindow in your preferences window, remove it.

GNOME Shell

Signals

GNOME Shell 42 uses connectObject() and disconnectObject() convenience methods instead of connect() and disconnect() methods.

You can use GObject.signal_handler_find()open in new window to find signal handler id.

For example, we are blocking overlay-key signal in global.display here:

let signalId = GObject.signal_handler_find(global.display, { signalId: 'overlay-key' });
GObject.signal_handler_block(global.display, signalId);
1
2

You can simply use GObject.signal_handler_unblock() to unblock that signal id:

GObject.signal_handler_unblock(global.display, signalId);
1

Desktop

Color scheme

GNOME Shell 42 supports color scheme for the user interface.

You can find the new gsettings schema id in org.gnome.desktop.interface.color-scheme that accepts "default", "prefer-dark" and "prefer-light".

ui.background.BackgroundSource.getBackground() is using color-scheme to get the background.

OSD Window

OSD window no longer uses ui.osdWindow.OsdWindowConstraint and ui.osdWindow.OsdWindow._relayout().

Instead, ui.osdWindow.OsdWindow is vertically aligned at the end and .osd-window style class is using margin-bottom to move it up from the bottom of the screen.

Screenshot

GNOME Shell 42 ships with built-in screenshot tool. You can find it in ui.screenshot.ScreenshotUI.

There are two screenshot modes (ui.screenshot.UIMode):

  • SCREENSHOT to take a picture from screen.
  • SCREENCAST to capture video from screen.

These are style class names used in Screenshot UI:

  • .screenshot-ui-area-selector
  • .screenshot-ui-capture-button-circle
  • .screenshot-ui-close-button
  • .screenshot-ui-panel (Wrapper for the controls at the bottom of the screen)
  • .screenshot-ui-screencast-area-indicator
  • .screenshot-ui-screen-screenshot (UI wrapper)
  • .screenshot-ui-screen-selector
  • .screenshot-ui-shot-cast-button
  • .screenshot-ui-shot-cast-container
  • .screenshot-ui-tooltip
  • .screenshot-ui-type-button
  • .screenshot-ui-type-button-container
  • .screenshot-ui-window-selector
TypeWhere
Direct Accessui.main.screenshotUI
Created Inui.main._initializeUI()
Direct Access (UI Group)ui.main.layoutManager.screenshotUIGroup
Created In (UI Group)ui.screenshot.ScreenshotUI

Since there is a screen cast mode, we have new screen recording indicator in panel (ui.status.remoteAccess.ScreenRecordingIndicator). This element only shows up while the screenshot is recording.

TypeWhere
Direct Accessui.main.panel.statusArea.screenRecording

Workspace Switcher Popup

Workspace switcher popup (ui.workspaceSwitcherPopup.WorkspaceSwitcherPopup) has been revamped and these style class names no longer exist:

  • .workspace-switcher-group
  • .workspace-switcher-container
  • .ws-switcher-active-up
  • .ws-switcher-active-down
  • .ws-switcher-active-left
  • .ws-switcher-active-right
  • .ws-switcher-box

Just like osd window it is vertically aligned at the end and .workspace-switcher style class is using margin-bottom to move it up from the bottom of the screen.

TypeWhere
Style Class.workspace-switcher
Style Class (indicator).ws-switcher-indicator
Style Class (active indicator).ws-switcher-indicator::active

Top Panel

Panel Corner

ui.panel.PanelCorner class and .panel-corner style class no longer exist in GNOME Shell 42.

ui.popupMenu.PopupMenuSection is using .popup-menu-section style class and you can use it to modify the popup menu section look.

Window Menu

Window menu added a new menu item for screenshot and you can find it in ui.main.windowMenu.WindowMenu.

GJS

TIP

There were no relevant to GJS in GNOME 42.

Last Updated: 11/12/2023, 12:06:47 AM
Contributors: Javad Rahmatzadeh, Andy Holmes, Mattias Bengtsson