WezTerm Tabs

https://github.com/yriveiro/wezterm-tabs
Admin
WezTerm Tabs is a configurable tab bar plugin for WezTerm that provides customizable UI elements...
Tokens:4,569
Snippets:26
Trust Score:8.4
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install WezTerm Tabs Plugin

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Basic installation of the WezTerm Tabs plugin using WezTerm's native plugin system. This snippet requires the plugin from its GitHub repository and applies it to the WezTerm configuration with default settings.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Basic installation with default settings
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config)

return config
```

--------------------------------

### Install WezTerm Tabs Plugin

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

Integrates the WezTerm Tabs plugin into your WezTerm configuration using the native plugin system. This snippet shows the basic require and apply_to_config calls.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

...

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config)
```

--------------------------------

### Complete WezTerm Tabs Configuration with Lua

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

This Lua configuration sets up WezTerm with the wezterm-tabs plugin. It defines a retro color scheme for the tab bar and applies extensive customizations to tab appearance, separators, and process icons using Nerd Fonts. This example requires the wezterm-tabs plugin to be installed.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Set up color scheme for retro tab bar
config.colors = {
  tab_bar = {
    background = '#1a1b26',
    active_tab = {
      bg_color = '#7aa2f7',
      fg_color = '#1a1b26',
      intensity = 'Bold',
    },
    inactive_tab = {
      bg_color = '#24283b',
      fg_color = '#565f89',
    },
    inactive_tab_hover = {
      bg_color = '#414868',
      fg_color = '#c0caf5',
      italic = true,
    },
    new_tab = {
      bg_color = '#24283b',
      fg_color = '#565f89',
    },
    new_tab_hover = {
      bg_color = '#414868',
      fg_color = '#c0caf5',
      italic = true,
    },
  },
}

-- Apply wezterm-tabs plugin with full customization
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    tabs = {
      tab_bar_at_bottom = true,
      hide_tab_bar_if_only_one_tab = false,
      tab_max_width = 36,
      unzoom_on_switch_pane = true,
    },
    ui = {
      separators = {
        arrow_solid_left = '\u{e0b0}',
        arrow_solid_right = '\u{e0b2}',
        arrow_thin_left = '\u{e0b1}',
        arrow_thin_right = '\u{e0b3}',
      },
      icons = {
        ['nvim'] = wezterm.nerdfonts.custom_vim,
        ['vim'] = wezterm.nerdfonts.dev_vim,
        ['git'] = wezterm.nerdfonts.dev_git,
        ['lazygit'] = wezterm.nerdfonts.dev_github_alt,
        ['docker'] = wezterm.nerdfonts.linux_docker,
        ['kubectl'] = wezterm.nerdfonts.linux_docker,
        ['cargo'] = wezterm.nerdfonts.dev_rust,
        ['go'] = wezterm.nerdfonts.seti_go,
        ['node'] = wezterm.nerdfonts.md_hexagon,
        ['python'] = wezterm.nerdfonts.dev_python,
        ['bash'] = wezterm.nerdfonts.cod_terminal_bash,
        ['zsh'] = wezterm.nerdfonts.dev_terminal,
      },
      tab = {
        zoom_indicator = {
          enabled = true,
          type = 'icon',
        },
      },
    },
  })

return config

```

--------------------------------

### Configure WezTerm Tabs Plugin Options

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

Customizes the WezTerm Tabs plugin by passing configuration options to the `apply_to_config` method. This example demonstrates setting the tab bar position.

```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 } })
```

--------------------------------

### Configure WezTerm UI Separators

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

Customizes the Unicode characters used for separators within the WezTerm UI, particularly for tab separators. This example shows Powerline-style arrow characters.

```lua
ui.separators = {
  arrow_solid_left = '\u{e0b0}',
  arrow_solid_right = '\u{e0b2}',
  arrow_thin_left = '\u{e0b1}',
  arrow_thin_right = '\u{e0b3}',
}
```

--------------------------------

### Configure WezTerm Tabs Visibility

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Configuration snippet to control the visibility of the WezTerm tab bar. This example hides the tab bar when only one tab is open and allows for wider tabs by setting `tab_max_width`.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Hide tab bar when only one tab is open
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    tabs = {
      hide_tab_bar_if_only_one_tab = true,
      tab_max_width = 40, -- Allow wider tabs
    },
  })

return config
```

--------------------------------

### Configure Program Icons with Nerd Fonts in WezTerm

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

This Lua code snippet configures a table of icons for various development tools, shells, text editors, and utilities using WezTerm's Nerd Fonts integration. It maps program names to specific Nerd Font characters, allowing for visual representation in the WezTerm interface. Ensure Nerd Fonts are installed and configured in WezTerm for these icons to display correctly.

```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,
}
```

--------------------------------

### Configure WezTerm Tabs Bar Position

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Configuration snippet to set the WezTerm tab bar position. This example places the tab bar at the top of the terminal window by setting `tab_bar_at_bottom` to `false`.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Place tab bar at the top of the window
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    tabs = {
      tab_bar_at_bottom = false,
    },
  })

return config
```

--------------------------------

### Configure WezTerm Tabs Plugin with All Options

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Full configuration of the WezTerm Tabs plugin, demonstrating all available options for tabs and UI elements. This includes tab bar position, visibility, maximum width, zoom behavior, custom separators, and program-specific icons using Nerd Fonts.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Full configuration with all available options
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    tabs = {
      -- Position tab bar at bottom of window (default: true)
      tab_bar_at_bottom = true,
      -- Hide tab bar when only one tab exists (default: false)
      hide_tab_bar_if_only_one_tab = false,
      -- Maximum width of each tab in cells (default: 32)
      tab_max_width = 32,
      -- Restore zoom when switching panes (default: true)
      unzoom_on_switch_pane = true,
    },
    ui = {
      separators = {
        arrow_solid_left = '\u{e0b0}',
        arrow_solid_right = '\u{e0b2}',
        arrow_thin_left = '\u{e0b1}',
        arrow_thin_right = '\u{e0b3}',
      },
      icons = {
        ['nvim'] = wezterm.nerdfonts.custom_vim,
        ['git'] = wezterm.nerdfonts.dev_git,
        ['docker'] = wezterm.nerdfonts.linux_docker,
      },
      tab = {
        zoom_indicator = {
          enabled = true,
          type = 'icon', -- 'icon' or 'number'
        },
      },
    },
  })

return config
```

--------------------------------

### Configure WezTerm Tabs Section

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

Defines basic behavior and appearance settings for the tabs in WezTerm. Options include tab bar position, visibility when only one tab exists, maximum tab width, and zoom behavior when switching panes.

```lua
tabs = {
  tab_bar_at_bottom = true,
  hide_tab_bar_if_only_one_tab = false,
  tab_max_width = 32,
  unzoom_on_switch_pane = true,
}
```

--------------------------------

### Configure Custom Process Icons in WezTerm

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Maps specific process names to Nerd Font glyphs to display icons in the tab bar. This requires the wezterm-tabs plugin and utilizes the wezterm.nerdfonts module.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    ui = {
      icons = {
        ['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,
        ['make'] = wezterm.nerdfonts.seti_makefile,
        ['bash'] = wezterm.nerdfonts.cod_terminal_bash,
        ['zsh'] = wezterm.nerdfonts.dev_terminal,
        ['nvim'] = wezterm.nerdfonts.custom_vim,
        ['vim'] = wezterm.nerdfonts.dev_vim,
        ['docker'] = wezterm.nerdfonts.linux_docker,
        ['docker-compose'] = wezterm.nerdfonts.linux_docker,
        ['kubectl'] = wezterm.nerdfonts.linux_docker,
        ['curl'] = wezterm.nerdfonts.md_waves,
        ['wget'] = wezterm.nerdfonts.md_arrow_down_box,
        ['gh'] = wezterm.nerdfonts.dev_github_badge,
        ['lazygit'] = wezterm.nerdfonts.dev_github_alt,
        ['sudo'] = wezterm.nerdfonts.fa_hashtag,
        ['python'] = wezterm.nerdfonts.dev_python,
        ['ruby'] = wezterm.nerdfonts.dev_ruby,
      },
    },
  })

return config
```

--------------------------------

### Configure Zoom Indicators in WezTerm

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Enables visual indicators for zoomed panes in the tab bar. Supports either a static icon or a dynamic subscript number indicating the pane count.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    ui = {
      tab = {
        zoom_indicator = {
          enabled = true,
          type = 'icon',
        },
      },
    },
  })

return config
```

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    ui = {
      tab = {
        zoom_indicator = {
          enabled = true,
          type = 'number',
        },
      },
    },
  })

return config
```

--------------------------------

### Configure WezTerm Custom Separators

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Configuration snippet for customizing the Powerline-style separator characters used between tabs in WezTerm. This requires a Nerd Font to render correctly and defines characters for solid and thin arrows.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Use custom separator characters
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config, {
    ui = {
      separators = {
        -- Powerline-style solid arrows
        arrow_solid_left = '\u{e0b0}',
        arrow_solid_right = '\u{e0b2}',
        -- Powerline-style thin arrows
        arrow_thin_left = '\u{e0b1}',
        arrow_thin_right = '\u{e0b3}',
      },
    },
  })

return config
```

--------------------------------

### Define Required Tab Bar Color Scheme

Source: https://context7.com/yriveiro/wezterm-tabs/llms.txt

Sets the necessary color palette for the retro tab bar appearance. This configuration must be applied to the WezTerm config object before initializing the plugin.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

config.colors = {
  tab_bar = {
    background = '#0b0022',
    active_tab = {
      bg_color = '#2b2042',
      fg_color = '#c0c0c0',
      intensity = 'Normal',
      underline = 'None',
      italic = false,
      strikethrough = false,
    },
    inactive_tab = {
      bg_color = '#1b1032',
      fg_color = '#808080',
    },
    inactive_tab_hover = {
      bg_color = '#3b3052',
      fg_color = '#909090',
      italic = true,
    },
    new_tab = {
      bg_color = '#1b1032',
      fg_color = '#808080',
    },
    new_tab_hover = {
      bg_color = '#3b3052',
      fg_color = '#909090',
      italic = true,
    },
  },
}

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-tabs')
  .apply_to_config(config)

return config
```

--------------------------------

### Configure WezTerm Tab Bar Colors

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

Sets the color scheme for the WezTerm tab bar, including active, inactive, and new tab appearances. This configuration requires the 'Retro Bar' appearance to be enabled.

```lua
config.colors = {
  tab_bar = {
    background = '#0b0022',

    active_tab = {
      bg_color = '#2b2042',
      fg_color = '#c0c0c0',
      intensity = 'Normal',
      underline = 'None',
      italic = false,
      strikethrough = false,
    },

    inactive_tab = {
      bg_color = '#1b1032',
      fg_color = '#808080',
    },

    inactive_tab_hover = {
      bg_color = '#3b3052',
      fg_color = '#909090',
      italic = true,
    },

    new_tab = {
      bg_color = '#1b1032',
      fg_color = '#808080',
    },

    new_tab_hover = {
      bg_color = '#3b3052',
      fg_color = '#909090',
      italic = true,
    },
  },
}
```

--------------------------------

### Configure WezTerm Tab Zoom Indicator

Source: https://github.com/yriveiro/wezterm-tabs/blob/main/README.md

This Lua code snippet configures the tab-specific UI elements in WezTerm, specifically enabling and setting the display type for the zoom indicator. It allows users to choose whether to display the zoom level indicator and how it should be represented (e.g., as an icon). This configuration is part of the broader WezTerm tab settings.

```lua
ui.tab = {
  zoom_indicator = {
    -- Enable zoom level indicator
    enabled = true,
    -- Display type of the zoom indicator
    type = 'icon',
  }
}
```
Tokens:
Raw