https://github.com/yriveiro/wezterm-tabs
WezTerm to configure tabs look and feel
https://github.com/yriveiro/wezterm-tabs
plugin wezterm wezterm-plugin
Last synced: 5 months ago
JSON representation
WezTerm to configure tabs look and feel
- Host: GitHub
- URL: https://github.com/yriveiro/wezterm-tabs
- Owner: yriveiro
- License: mit
- Created: 2024-08-04T10:38:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-01T20:20:03.000Z (5 months ago)
- Last Synced: 2025-01-01T21:25:22.624Z (5 months ago)
- Topics: plugin, wezterm, wezterm-plugin
- Language: Lua
- Homepage:
- Size: 30.3 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WezTerm Tabs
This project provides a configurable tab bar for [WezTerm](https://wezfurlong.org/wezterm/index.html),
a GPU-accelerated terminal emulator.
# Installation
This project works with the native plugin system provided by WezTerm.
Modify your WezTerm configuration file (~/.config/wezterm/wezterm.lua) to include
the status bar script:
```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()
...
wezterm.plugin
.require('https://github.com/yriveiro/wezterm-tabs')
.apply_to_config(config)
```
# Setup
To customize the plugin, the method `apply_to_config` accepts a second argument
for the plugin options.
In this example, we are configuring the position of the tab bar.
```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()
...
wezterm.plugin
.require('https://github.com/yriveiro/wezterm-tabs')
.apply_to_config(config, { tabs = { tab_bar_at_bottom = false } })
```
> [!NOTE]
> This plugin uses Retro Bar appearance to work, that means you need to have
> configured the `tab_bar` [color properties](https://wezfurlong.org/wezterm/config/appearance.html#retro-tab-bar-appearance)
```lua
config.colors = {
tab_bar = {
-- The color of the strip that goes along the top of the window
-- (does not apply when fancy tab bar is in use)
background = '#0b0022',
-- The active tab is the one that has focus in the window
active_tab = {
-- The color of the background area for the tab
bg_color = '#2b2042',
-- The color of the text for the tab
fg_color = '#c0c0c0',
-- Specify whether you want "Half", "Normal" or "Bold" intensity for the
-- label shown for this tab.
-- The default is "Normal"
intensity = 'Normal',
-- Specify whether you want "None", "Single" or "Double" underline for
-- label shown for this tab.
-- The default is "None"
underline = 'None',
-- Specify whether you want the text to be italic (true) or not (false)
-- for this tab. The default is false.
italic = false,
-- Specify whether you want the text to be rendered with strikethrough (true)
-- or not for this tab. The default is false.
strikethrough = false,
},
-- Inactive tabs are the tabs that do not have focus
inactive_tab = {
bg_color = '#1b1032',
fg_color = '#808080',
-- The same options that were listed under the `active_tab` section above
-- can also be used for `inactive_tab`.
},
-- You can configure some alternate styling when the mouse pointer
-- moves over inactive tabs
inactive_tab_hover = {
bg_color = '#3b3052',
fg_color = '#909090',
italic = true,
-- The same options that were listed under the `active_tab` section above
-- can also be used for `inactive_tab_hover`.
},
-- The new tab button that let you create new tabs
new_tab = {
bg_color = '#1b1032',
fg_color = '#808080',
-- The same options that were listed under the `active_tab` section above
-- can also be used for `new_tab`.
},
-- You can configure some alternate styling when the mouse pointer
-- moves over the new tab button
new_tab_hover = {
bg_color = '#3b3052',
fg_color = '#909090',
italic = true,
-- The same options that were listed under the `active_tab` section above
-- can also be used for `new_tab_hover`.
},
},
}
```
# Available configurations
## Tabs Section
Controls the basic behavior and appearance of tabs.
```lua
tabs = {
-- Position the tab bar at the bottom of the window
tab_bar_at_bottom = true,
-- Controls visibility of the tab bar when only one tab exists
hide_tab_bar_if_only_one_tab = false,
-- Maximum width of each tab in cells
tab_max_width = 32,
-- Whether to restore zoom level when switching panes
unzoom_on_switch_pane = true,
}
```
## UI Section
Defines various UI elements including separators and program-specific icons.
### Separators
Custom Unicode characters for tab separators:
```lua
ui.separators = {
-- Powerline-style solid arrow pointing left
arrow_solid_left = '\u{e0b0}',
-- Powerline-style solid arrow pointing right
arrow_solid_right = '\u{e0b2}',
-- Powerline-style thin arrow pointing left
arrow_thin_left = '\u{e0b1}',
-- Powerline-style thin arrow pointing right
arrow_thin_right = '\u{e0b3}',
}
```
### Icons
Program-specific icons using Nerd Fonts:
```lua
ui.icons = {
-- Development Tools
['debug'] = wezterm.nerdfonts.cod_debug_console,
['cargo'] = wezterm.nerdfonts.dev_rust,
['git'] = wezterm.nerdfonts.dev_git,
['go'] = wezterm.nerdfonts.seti_go,
['lua'] = wezterm.nerdfonts.seti_lua,
['node'] = wezterm.nerdfonts.md_hexagon,
-- Shells and Terminals
['bash'] = wezterm.nerdfonts.cod_terminal_bash,
['zsh'] = wezterm.nerdfonts.dev_terminal,
-- Text Editors
['nvim'] = wezterm.nerdfonts.custom_vim,
['vim'] = wezterm.nerdfonts.dev_vim,
-- Container and Cloud Tools
['docker'] = wezterm.nerdfonts.linux_docker,
['docker-compose'] = wezterm.nerdfonts.linux_docker,
['kubectl'] = wezterm.nerdfonts.linux_docker,
-- Utilities
['curl'] = wezterm.nerdfonts.md_waves,
['gh'] = wezterm.nerdfonts.dev_github_badge,
['make'] = wezterm.nerdfonts.seti_makefile,
['sudo'] = wezterm.nerdfonts.fa_hashtag,
['wget'] = wezterm.nerdfonts.md_arrow_down_box,
['lazygit'] = wezterm.nerdfonts.dev_github_alt,
}
```
### Tab Settings
Configuration for tab-specific UI elements:
```lua
ui.tab = {
zoom_indicator = {
-- Enable zoom level indicator
enabled = true,
-- Display type of the zoom indicator
type = 'icon',
}
}
```
# Usage
Once configured, the tab bar will automatically update with the relevant
information when WezTerm is running.
# Contributing
Contributions are welcome! Please open an issue or submit a pull request with your improvements.
# License
This project is licensed under the MIT License. See the LICENSE file for details.