feat: customize quick terminal size #3742

dmehala · 2024-12-28T16:21:17Z

Description

This commit introduce quick-terminal-size option which allows to define the size of the quick terminal.

It also fixes an issue where the quick terminal position was not properly updated when reloading the configuration.

Resolves #2384

This commit introduce `quick-terminal-size` option which allows to define the size of the quick terminal. It also fixes an issue where the quick terminal position was not properly updated when reloading the configuration. Resolves ghostty-org#2384

dmehala · 2024-12-28T16:25:22Z

src/config/Config.zig

+/// Control the size of the quick terminal.
+///
+/// The size can expressed in two units:
+///  * A value ending in `%` specifies a percentage of the screen size.
+///  * A value ending in `px` specifies a fixed size in pixel, which is clamped by the
+///    screen's maximum width or height.
+///
+/// The configuration accept one or two dimensions:
+///  * A single value specifies the dimension that is growable based on the quick terminal
+///   position:
+///    * For `top` and `bottom` positions, the value applies to the height.
+///    * For `right` and `left` positions, the value applies to the width.
+///    * For `center`, the size applied to both the width and height.
+///  * Two comma separated value specifies the width and height.
+///
+/// Examples:
+///
+/// ```
+/// quick-terminal-size = 25%       // 25% of the maximum size for the growable dimension
+/// quick-terminal-size = 42px      // 42 pixels for the growable dimension
+/// quick-terminal-size = 25%,75%   // 25% for the primary dimension, 75% for the secondary
+/// quick-terminal-size = 300px,80% // 300px for the primary dimension, 80% for the secondary
+/// ```


I am not a native English speaker, so feel free to change the wording 😅.

dmehala · 2024-12-28T16:30:46Z

macos/Sources/Features/QuickTerminal/QuickTerminalSize.swift

+        func apply(value: CGFloat) -> CGFloat {
+            switch(self) {
+            case .pixel(let fixed_size):
+                return CGFloat(fixed_size);


Suggested change

return CGFloat(fixed_size);

return min(value, CGFloat(fixed_size));

dmehala · 2024-12-28T16:35:53Z

src/config/Config.zig

+            };
+        }
+
+        fn parseValue(input: []const u8) !Size {


[Nitpick] Parsing could be improve, quick-terminal-size: 20%, 30% will probably fail due to the space after the comma. I could/should fix it, but other config suffers from the same issue and should probably be fixed in a subsequent PR.

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

dmehala · 2024-12-29T12:09:53Z

macos/Sources/Features/QuickTerminal/QuickTerminalSize.swift

+        init?(c_dimension: ghostty_config_quick_terminal_dimension_s) {
+            switch(c_dimension.unit) {
+            case GHOSTTY_QUICK_TERMINAL_PIXEL_UNIT:
+                self = .pixel(value: UInt(c_dimension.value))


[TODO] Use screen scale (IIRC retina has a scale of 2-3 while standard display is 1. backingScaleFactor?

Jaycedam · 2024-12-29T18:07:46Z

Hi I've been trying this out, thank you for working on this.
I have some issues but I could be doing something wrong, when using:

quick-terminal-position = center
quick-terminal-size = 80%

only the width is modified

using two values works as expected
quick-terminal-size = 80%,80%

~~Also the global keybind stopped working but maybe that's a different issue?~~

dmehala · 2024-12-29T22:40:15Z

Hey @Jaycedam

I have some issues but I could be doing something wrong, when using:
quick-terminal-position = center
quick-terminal-size = 80%
only the width is modified

This is the expected behaviour, howver, I agree for center position it seems natural to expect the size to change on both dimensions unless a second dimension is specified. I am planning to push this change. Here's a preview:

NOTE: I have an ultrawide monitor.

Also the global keybind stopped working but maybe that's a different issue?

The PR doesn't include any changes related to global keybindings, so that would be a surprising side effect. Unfortunately, I am not able to reproduce the issue. Could you share the steps to reproduce it with you configuration? Thank you.

Jaycedam · 2024-12-29T23:01:14Z

This is the expected behaviour, howver, I agree for center position it seems natural to expect the size to change on both dimensions

I was confused by the wording of the documentation added here, but as long as it reflects the usage I think it will be easy to understand.

The configuration accept one or two dimensions:

A single value specifies the dimension that is growable based on the quick terminal position:

For center, the size applied to both the width and height.

The global keybind was a problem on my end so ignore it. Re-enabling the accesibility toggle fixed it.

YANOUSHek · 2024-12-30T13:29:08Z

I know I'm a little late to the party but I just started using ghostty today. Shouldn't we also allow to specify the size of the quick terminal in rows and cols? So

quick-terminal-size = 120,50

would create a window that has 120 columns and 50 rows.

Dolvur · 2024-12-30T18:20:17Z

I know I'm a little late to the party but I just started using ghostty today. Shouldn't we also allow to specify the size of the quick terminal in rows and cols? So
quick-terminal-size = 120,50
would create a window that has 120 columns and 50 rows.

This was mentioned as a future enhancement due to it being more complex #2384 (comment)

Also thank you dmehala for working on this. I always use a fullscreen hotkey toggle for my terminal needs

donaldguy

locally rebased this onto tip (at 8f5f432)

there were some detected-conflicts in QuickTerminalController.swift (vs #4055 )

they are all fairly obvious resolutions but to (potentially) save you the trouble (modulo if you have strong feelings about a different order)

[see below for one ~substantive question]

donaldguy · 2025-01-04T20:16:48Z

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

@@ -390,25 +393,32 @@ class QuickTerminalController: BaseTerminalController {

        // Update our derived config
        self.derivedConfig = DerivedConfig(config)
-
+        self.position = self.derivedConfig.quickTerminalPosition
+
        syncAppearance(config)


Suggested change

syncAppearance(config)

syncAppearance()

donaldguy · 2025-01-04T20:18:31Z

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

+        let quickTerminalPosition: QuickTerminalPosition
+        let quickTerminalSize: QuickTerminalSize


Suggested change

let quickTerminalPosition: QuickTerminalPosition

let quickTerminalSize: QuickTerminalSize

let quickTerminalPosition: QuickTerminalPosition

let quickTerminalSize: QuickTerminalSize

let windowColorspace: String

let backgroundOpacity: Double

or your preferred order

donaldguy · 2025-01-04T20:19:26Z

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

+            self.quickTerminalPosition = config.quickTerminalPosition
+            self.quickTerminalSize = config.quickTerminalSize


Suggested change

self.quickTerminalPosition = config.quickTerminalPosition

self.quickTerminalSize = config.quickTerminalSize

self.quickTerminalPosition = config.quickTerminalPosition

self.quickTerminalSize = config.quickTerminalSize

self.windowColorspace = config.windowColorspace

self.backgroundOpacity = config.backgroundOpacity

donaldguy · 2025-01-04T20:20:14Z

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

+            self.quickTerminalPosition = .top
+            self.quickTerminalSize = .init()


Suggested change

self.quickTerminalPosition = .top

self.quickTerminalSize = .init()

self.quickTerminalPosition = .top

self.quickTerminalSize = .init()

self.windowColorspace = ""

self.backgroundOpacity = 1.0

donaldguy · 2025-01-04T20:53:19Z

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift

+
+        // Update the quick terminal size right away
+        config.quickTerminalSize.apply(window, config.quickTerminalPosition)


FYI, since you removed the function param this config symbol no longer resolves and tanks the swift compilation.

not sure if the invocation up at 75 (72 in my rebased version) is adequate or if this wants to stay but go:

Suggested change

// Update the quick terminal size right away

config.quickTerminalSize.apply(window, config.quickTerminalPosition)

// Update the quick terminal size right away

self.derivedConfig.quickTerminalSize.apply(window, self.position)

or something else

feat: customize quick terminal size

3da908a

This commit introduce `quick-terminal-size` option which allows to define the size of the quick terminal. It also fixes an issue where the quick terminal position was not properly updated when reloading the configuration. Resolves ghostty-org#2384

dmehala commented Dec 28, 2024

View reviewed changes

macos/Sources/Features/QuickTerminal/QuickTerminalController.swift Show resolved Hide resolved

mitchellh added this to the 1.0.1 milestone Dec 29, 2024

dmehala commented Dec 29, 2024

View reviewed changes

dmehala mentioned this pull request Dec 30, 2024

macOS: QuickTerminal under certain circumstances spins at 100% CPU #3998

Closed

mitchellh removed this from the 1.0.1 milestone Dec 30, 2024

donaldguy reviewed Jan 4, 2025

View reviewed changes

This was referenced Jan 4, 2025

Customize initial size for quick terminal #2384

Open

(alt) feat: customize quick terminal size #4716

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: customize quick terminal size #3742

feat: customize quick terminal size #3742

dmehala commented Dec 28, 2024

dmehala Dec 28, 2024 •

edited

Loading

dmehala Dec 28, 2024

dmehala Dec 28, 2024

dmehala Dec 29, 2024 •

edited

Loading

Jaycedam commented Dec 29, 2024 •

edited

Loading

dmehala commented Dec 29, 2024 •

edited

Loading

Jaycedam commented Dec 29, 2024

YANOUSHek commented Dec 30, 2024

Dolvur commented Dec 30, 2024

donaldguy left a comment

donaldguy Jan 4, 2025

donaldguy Jan 4, 2025

donaldguy Jan 4, 2025

donaldguy Jan 4, 2025

donaldguy Jan 4, 2025 •

edited

Loading

	return CGFloat(fixed_size);
	return min(value, CGFloat(fixed_size));

		let quickTerminalPosition: QuickTerminalPosition
		let quickTerminalSize: QuickTerminalSize

		self.quickTerminalPosition = config.quickTerminalPosition
		self.quickTerminalSize = config.quickTerminalSize

		self.quickTerminalPosition = .top
		self.quickTerminalSize = .init()


		// Update the quick terminal size right away
		config.quickTerminalSize.apply(window, config.quickTerminalPosition)

feat: customize quick terminal size #3742

Are you sure you want to change the base?

feat: customize quick terminal size #3742

Conversation

dmehala commented Dec 28, 2024

Description

dmehala Dec 28, 2024 • edited Loading

Choose a reason for hiding this comment

dmehala Dec 28, 2024

Choose a reason for hiding this comment

dmehala Dec 28, 2024

Choose a reason for hiding this comment

dmehala Dec 29, 2024 • edited Loading

Choose a reason for hiding this comment

Jaycedam commented Dec 29, 2024 • edited Loading

dmehala commented Dec 29, 2024 • edited Loading

Jaycedam commented Dec 29, 2024

YANOUSHek commented Dec 30, 2024

Dolvur commented Dec 30, 2024

donaldguy left a comment

Choose a reason for hiding this comment

donaldguy Jan 4, 2025

Choose a reason for hiding this comment

donaldguy Jan 4, 2025

Choose a reason for hiding this comment

donaldguy Jan 4, 2025

Choose a reason for hiding this comment

donaldguy Jan 4, 2025

Choose a reason for hiding this comment

donaldguy Jan 4, 2025 • edited Loading

Choose a reason for hiding this comment

dmehala Dec 28, 2024 •

edited

Loading

dmehala Dec 29, 2024 •

edited

Loading

Jaycedam commented Dec 29, 2024 •

edited

Loading

dmehala commented Dec 29, 2024 •

edited

Loading

donaldguy Jan 4, 2025 •

edited

Loading