1
1
mirror of https://github.com/wez/wezterm.git synced 2024-11-27 02:25:28 +03:00

docs: for integrated title buttons

refs: https://github.com/wez/wezterm/pull/2722
refs: https://github.com/wez/wezterm/issues/1180
This commit is contained in:
Wez Furlong 2023-04-07 13:09:26 -07:00
parent 56ae2fe276
commit b0d0e4c1be
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
7 changed files with 103 additions and 1 deletions

View File

@ -52,7 +52,14 @@ As features stabilize some brief notes about them will accumulate here.
[wezterm.default_ssh_domains()](config/lua/wezterm/default_ssh_domains.md) to [wezterm.default_ssh_domains()](config/lua/wezterm/default_ssh_domains.md) to
obtain that same information and amend/extend it. obtain that same information and amend/extend it.
* [display_pixel_geometry](config/lua/config/display_pixel_geometry.md) to specify subpixel antialiasing geometry. ?3422 * [display_pixel_geometry](config/lua/config/display_pixel_geometry.md) to specify subpixel antialiasing geometry. ?3422
* In progress: integrated title and tab bar. Thanks to @yuraiz for getting things moving! #2722 * Integrated title and tab bar.
See also [window_decorations](config/lua/config/window_decorations.md),
[integrated_title_button_style](config/lua/config/integrated_title_button_style.md),
[integrated_title_buttons](config/lua/config/integrated_title_buttons.md),
[integrated_title_button_alignment](config/lua/config/integrated_title_button_alignment.md)
[integrated_title_button_color](config/lua/config/integrated_title_button_color.md) and,
if you are using the retro tab bar, [tab_bar_style](config/lua/config/tab_bar_style.md).
Thanks to @yuraiz for getting things moving! #2722 #1180
* Lua: [gui_window:active_tab()](config/lua/window/active_tab.md), * Lua: [gui_window:active_tab()](config/lua/window/active_tab.md),
[gui_window:active_pane()](config/lua/window/active_pane.md) (surprise! this was already there, just undocumented!), [gui_window:active_pane()](config/lua/window/active_pane.md) (surprise! this was already there, just undocumented!),
[mux_window:active_tab()](config/lua/mux-window/active_tab.md), [mux_window:active_tab()](config/lua/mux-window/active_tab.md),

View File

@ -0,0 +1,13 @@
# `integrated_title_button_alignment = "Right"`
{{since('nightly')}}
Configures the alignment of the set of window management buttons when
`window_decorations = "INTEGRATED_BUTTONS|RESIZE"`.
Possible values are:
* `"Left"` - the buttons are shown on the left side of the tab bar
* `"Right"` - the buttons are shown on the right side of the tab bar

View File

@ -0,0 +1,11 @@
# `integrated_title_button_color = "Auto"`
{{since('nightly')}}
Configures the color of the set of window management buttons when
`window_decorations = "INTEGRATED_BUTTONS|RESIZE"`.
Possible values are:
* `config.integrated_title_button_color = "Auto"` - automatically compute the color
* `config.integrated_title_button_color = "red"` - Use a custom color

View File

@ -0,0 +1,16 @@
# `integrated_title_button_style = STYLE`
{{since('nightly')}}
Configures the visual style of the tabbar-integrated titlebar button
replacements that are shown when `window_decorations =
"INTEGRATED_BUTTONS|RESIZE"`.
Possible styles are:
* `"Windows"` - draw Windows-style buttons
* `"Gnome"` - draw Adwaita-style buttons
* `"MacOsNative"` - on macOS only, move the native macOS buttons into the tab bar.
The default value is `"MacOsNative"` on macOS systems, but `"Windows"` on other
systems.

View File

@ -0,0 +1,32 @@
# `integrated_title_button_style = BUTTONS`
{{since('nightly')}}
Configures the ordering and set of window management buttons to show when
`window_decorations = "INTEGRATED_BUTTONS|RESIZE"`.
The value is a table listing the buttons. Each element can have one of
the following values:
* `"Hide"` - the window hide or minimize button
* `"Maximize"` - the window maximize button
* `"Close"` - the window close button
The default value is equivalent to:
```lua
config.integrated_title_buttons = { 'Hide', 'Maximize', 'Close' }
```
You can change the order by listing them in a different order:
```lua
config.integrated_title_buttons = { 'Close', 'Maximize', 'Hide' }
```
or remove buttons you don't want:
```lua
config.integrated_title_buttons = { 'Close' }
```

View File

@ -70,3 +70,15 @@ config.tab_bar_style = {
} }
``` ```
#### Retro Tab Bar with Integrated Window Management Buttons
{{since('nightly')}}
When using [`window_decorations =
"INTEGRATED_BUTTONS|RESIZE"`](window_decorations.md), you can
control how the different buttons are drawn for the retro tab bar:
* `window_hide`, `window_hide_hover` - the minimize/hide button
* `window_maximize`, `window_maximize_hover` - the maximize button
* `window_close`, `window_close_hover` - the close button

View File

@ -24,6 +24,17 @@ The value is a set of of flags:
[window_background_opacity](../../appearance.md#window-background-opacity) is set [window_background_opacity](../../appearance.md#window-background-opacity) is set
to less than `1.0`. to less than `1.0`.
{{since('nightly', outline=true)}}
* `window_decorations = "INTEGRATED_BUTTONS|RESIZE"` - place window
management buttons (minimize, maximize, close) into the tab bar
instead of showing a title bar.
See also [integrated_title_button_style](integrated_title_button_style.md),
[integrated_title_buttons](integrated_title_buttons.md),
[integrated_title_button_alignment](integrated_title_button_alignment.md)
[integrated_title_button_color](integrated_title_button_color.md) and,
if you are using the retro tab bar, [tab_bar_style](tab_bar_style.md).
On X11 and Wayland, the windowing system may override the window decorations. On X11 and Wayland, the windowing system may override the window decorations.
When the titlebar is disabled you can drag the window using the tab bar if it When the titlebar is disabled you can drag the window using the tab bar if it