version 15.1: smart window border, new keybindings, bugfixes and more! (#217)

Author: domferr

README.md

@@ -127,9 +127,13 @@ You can select your favorite layout for each workspace of each monitor.
 
 When a window is created, it is automatically moved to the best tile according to where other windows are tiled and the current layout. This is disabled by default and can be enabled in the preferences.
 
-
 [automatic_tiling](https://github.com/user-attachments/assets/76abc53f-2c6d-47ab-bee3-bbcdd946f2a1)
 
+### Export and import layouts ###
+
+*Tiling Shell* supports importing and exporting its layouts to a JSON file. With this you can create your own custom layouts without the built-in graphical editor, or share your layouts with others! If you are interested into knowing more about the contents of the layout file check the official [documentation](./doc/json-internal-documentation.md).
+
+
 <p align="right"><b>Go to Usage</b> <a href="#usage">⬆️</a></p>
 
 ## Installation

doc/example-layouts.json

@@ -0,0 +1,60 @@
+[
+	{
+		"id": "split-half",
+		"tiles": [
+			{
+				"x": 0,
+				"y": 0,
+				"width": 0.5,
+				"height": 1,
+				"groups": [
+					2
+				]
+			},
+			{
+				"x": 0.5,
+				"y": 0,
+				"width": 0.5,
+				"height": 1,
+				"groups": [
+					1
+				]
+			}
+		]
+	},
+	{
+		"id": "split-thirds",
+		"tiles": [
+			{
+				"x": 0,
+				"y": 0,
+				"width": 0.333,
+				"height": 1,
+				"groups": [
+					2,
+					3
+				]
+			},
+			{
+				"x": 0.333,
+				"y": 0,
+				"width": 0.333,
+				"height": 1,
+				"groups": [
+					3,
+					1
+				]
+			},
+			{
+				"x": 0.666,
+				"y": 0,
+				"width": 0.333,
+				"height": 1,
+				"groups": [
+					2,
+					1
+				]
+			}
+		]
+	}
+]

doc/json-internal-documentation.md

@@ -0,0 +1,79 @@
+# Documentation for JSON exported layouts
+
+*Tiling Shell* supports importing and exporting its layouts as a JSON file. With this you can create your own custom layouts, or fine-tune already existing layouts.
+
+The exported layouts (from the preferences) are a collection of `Layout` objects. A `Layout` object is an object with two (2) properties: 
+
+- identifier as a `string` 
+- a list of `Tile` objects
+
+Example JSON of a `Layout` object would look like
+
+```json
+{
+	"id": "The identifier",
+	"tiles": [
+		...
+	]
+}
+```
+
+A `Tile` object has five (5) properties:
+
+- The X (`x`) axis as a `float`
+- The Y (`y`) axis as a `float`
+- The width (`width`) as a `float`
+- The height (`height`) as a `float`
+- A list of identifiers `groups`
+
+The `x`, `y`, `width` and `height` are percentages relative to the screen size. Both `x` and `y` start from the top left of a `Tile`.
+
+So a `Tile` with `x` = 0.5 and `y` = 0.5, on a screen with a resolution of 1920x1080 pixels is placed at `x = 0.5 * 1920 = 960px` and `y = 0.5 * 1080 = 540px`. For example, if the `width` and `height` of the `Tile` are set to `0.25`, this gives a `Tile` of `width = 0.25 * 1920 = 480px` and `height = 0.25 * 1080 = 270px`.
+
+The `group` attribute is mainly used in the layout editor where it determines which `Tile`(s) are "linked": if you resize a single `Tile` it's linked neighbour(s) are also updated.
+
+For more in depth information you can look at an [in depth explanation](https://github.com/domferr/tilingshell/issues/177#issuecomment-2458322208) of `group`(s).
+
+Example JSON of a `Tile` object would look like this
+
+```json
+{
+	"x": 0,
+	"y": 0,
+	"width": 1,
+	"height": 1,
+	"groups": [
+		1
+	]
+}
+```
+
+## Example JSON file
+
+Finally, an example JSON file describing one Layout with two tiles.
+
+```json
+{
+	"id": "Equal split",
+	"tiles": [
+		{ 
+			"x": 0,
+			"y": 0,
+			"width": 0.5,
+			"height": 1,
+			"groups": [
+				1
+			]
+		},
+		{
+			"x": 0.5,
+			"y": 0,
+			"width": 0.5,
+			"height": 1,
+			"groups": [
+				1
+			]
+		}
+	]
+}
+```

esbuild.mjs

@@ -18,6 +18,10 @@ class Extension {
     getSettings() {
         return imports.misc.extensionUtils.getSettings();
     }
+
+    static openPrefs() {
+        return imports.misc.extensionUtils.openPrefs();
+    }
 }
 
 class Mtk { Rectangle }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tilingshell",
-  "version": "15.0",
+  "version": "15.1",
   "author": "Domenico Ferraro <[email protected]>",
   "private": true,
   "license": "GPL v2.0",

resources/icons/prefs-symbolic.svg

@@ -11,7 +11,7 @@
     "47"
   ],
   "version": 99,
-  "version-name": "15.0",
+  "version-name": "15.1",
   "url": "https://github.com/domferr/tilingshell",
   "settings-schema": "org.gnome.shell.extensions.tilingshell",
   "gettext-domain": "tilingshell",

resources/locale/it/LC_MESSAGES/tilingshell.mo

@@ -67,6 +67,11 @@
             <summary>Restore window size</summary>
             <description>Restore the windows to their original size when untiled.</description>
         </key>
+        <key name="enable-wraparound-focus" type="b">
+            <default>true</default>
+            <summary>Enable next/previous window focus to wrap around</summary>
+            <description>When focusing next or previous window, wrap around at the window edge</description>
+        </key>
         <key name="resize-complementing-windows" type="b">
             <default>true</default>
             <summary>Enable auto-resize of the complementing tiled windows</summary>
@@ -137,6 +142,11 @@
             <summary>Focused window border width</summary>
             <description>The width of the focused window's border.</description>
         </key>
+        <key name="enable-smart-window-border-radius" type="b">
+            <default>true</default>
+            <summary>Enable smart window border radius</summary>
+            <description>Dinamically adapt to the window's border radius.</description>
+        </key>
         <key name="snap-assistant-animation-time" type="u">
             <default>180</default>
             <summary>Snap assistant animation time (milliseconds)</summary>
@@ -209,6 +219,14 @@
 			<default><![CDATA[['']]]></default>
 			<summary>Focus the window below the current focused window</summary>
 		</key>
+		<key type="as" name="focus-window-next">
+			<default><![CDATA[['']]]></default>
+			<summary>Focus the window next to the current focused window</summary>
+		</key>
+		<key type="as" name="focus-window-prev">
+			<default><![CDATA[['']]]></default>
+			<summary>Focus the window prior to the current focused window</summary>
+		</key>
     </schema>
 
 </schemalist>

resources/metadata.json

@@ -18,7 +18,6 @@ export default class EditableTilePreview extends TilePreview {
     public static MIN_TILE_SIZE: number = 140;
 
     private readonly _btn: St.Button;
-    private readonly _tile: Tile;
     private readonly _containerRect: Mtk.Rectangle;
 
     private _sliders: (Slider | null)[];
@@ -51,10 +50,6 @@ export default class EditableTilePreview extends TilePreview {
         this.connect('destroy', this._onDestroy.bind(this));
     }
 
-    public get tile(): Tile {
-        return this._tile;
-    }
-
     public getSlider(side: St.Side): Slider | null {
         return this._sliders[side];
     }