visual-customization.md

  1# Visual Customization
  2
  3Various aspects of Zed's visual layout can be configured via Zed settings.json which you can access via {#action zed::OpenSettings} ({#kb zed::OpenSettings}).
  4
  5See [Configuring Zed](./configuring-zed.md) for additional information and other non-visual settings.
  6
  7## Themes
  8
  9Use may install zed extensions providing [Themes](./themes.md) and [Icon Themes](./icon-themes.md) via {#action zed::Extensions} from the command palette or menu.
 10
 11You can preview/choose amongsts your installed themes and icon themes with {#action theme_selector::Toggle} ({#kb theme_selector::Toggle}) and ({#action icon_theme_selector::Toggle}) which will modify the following settings:
 12
 13```json
 14{
 15  "theme": "One Dark",
 16  "icon_theme": "Zed (Default)"
 17}
 18```
 19
 20If you would like to use distinct themes for light mode/dark mode that can be set with:
 21
 22```json
 23{
 24  "theme": {
 25    "dark": "One Dark"
 26    "light": "One Light",
 27    // Mode to use (dark, light) or "system" to follow the OS's light/dark mode (default)
 28    "mode": "system",
 29  },
 30  "icon_theme": {
 31    "dark": "Zed (Default)"
 32    "light": "Zed (Default)",
 33    // Mode to use (dark, light) or "system" to follow the OS's light/dark mode (default)
 34    "mode": "system",
 35  }
 36}
 37```
 38
 39## Fonts
 40
 41```json
 42  // UI Font. Use ".SystemUIFont" to use the default system font (SF Pro on macOS)
 43  "ui_font_family": "Zed Plex Sans",
 44  "ui_font_weight": 400, // Font weight in standard CSS units from 100 to 900.
 45  "ui_font_size": 16,
 46
 47  // Buffer Font - Used by editor buffers
 48  "buffer_font_family": "Zed Plex Mono",  // Font name for editor buffers
 49  "buffer_font_size": 15,                 // Font size for editor buffers
 50  "buffer_font_weight": 400,              // Font weight in CSS units [100-900]
 51  // Line height "comfortable" (1.618), "standard" (1.3) or custom: `{ "custom": 2 }`
 52  "buffer_line_height": "comfortable",
 53
 54  // Terminal Font Settings
 55  "terminal": {
 56    "font_family": "Zed Plex Mono",
 57    "font_size": 15,
 58    // Terminal line height: comfortable (1.618), standard(1.3) or `{ "custom": 2 }`
 59    "line_height": "comfortable",
 60  },
 61
 62  // Agent Panel Font Settings
 63  "agent_font_size": 15
 64```
 65
 66### Font ligatures
 67
 68By default Zed enable font ligatures which will visually combines certain adjacent characters.
 69
 70For example `=>` will be displayed as `→` and `!=` will be `≠`. This is purely cosmetic and the individual characters remain unchanged.
 71
 72To disable this behavior use:
 73
 74```json
 75{
 76  "buffer_font_features": {
 77    "calt": false // Disable ligatures
 78  }
 79}
 80```
 81
 82### Status Bar
 83
 84```json
 85{
 86  // Whether to show full labels in line indicator or short ones
 87  //   - `short`: "2 s, 15 l, 32 c"
 88  //   - `long`: "2 selections, 15 lines, 32 characters"
 89  "line_indicator_format": "long"
 90
 91  // Individual status bar icons can be hidden:
 92  // "project_panel": {"button": false },
 93  // "outline_panel": {"button": false },
 94  // "collaboration_panel": {"button": false },
 95  // "chat_panel": {"button": "never" },
 96  // "git_panel": {"button": false },
 97  // "notification_panel": {"button": false },
 98  // "agent": {"button": false },
 99  // "debugger": {"button": false },
100  // "diagnostics": {"button": false },
101  // "search": {"button": false },
102}
103```
104
105### Titlebar
106
107```json
108  // Control which items are shown/hidden in the title bar
109  "title_bar": {
110    "show_branch_icon": false,      // Show/hide branch icon beside branch switcher
111    "show_branch_name": true,       // Show/hide branch name
112    "show_project_items": true,     // Show/hide project host and name
113    "show_onboarding_banner": true, // Show/hide onboarding banners
114    "show_user_picture": true,      // Show/hide user avatar
115    "show_sign_in": true,           // Show/hide sign-in button
116    "show_menus": false             // Show/hide menus
117  },
118```
119
120## Workspace
121
122```json
123{
124  // Force usage of Zed build in path prompts (file and directory pickers)
125  // instead of OS native pickers (false).
126  "use_system_path_prompts": true,
127  // Force usage of Zed built in confirmation prompts ("Do you want to save?")
128  // instead of OS native prompts (false). On linux this is ignored (always false).
129  "use_system_prompts": true,
130
131  // Whether to use the system provided dialogs for Open and Save As (true) or
132  // Zed's built-in keyboard-first pickers (false)
133  "use_system_path_prompts": true,
134
135  // Active pane styling settings.
136  "active_pane_modifiers": {
137    // Inset border size of the active pane, in pixels.
138    "border_size": 0.0,
139    // Opacity of the inactive panes. 0 means transparent, 1 means opaque.
140    "inactive_opacity": 1.0
141  },
142
143  // Layout mode of the bottom dock: contained, full, left_aligned, right_aligned
144  "bottom_dock_layout": "contained",
145
146  // Whether to resize all the panels in a dock when resizing the dock.
147  // Can be a combination of "left", "right" and "bottom".
148  "resize_all_panels_in_dock": ["left"]
149}
150```
151
152<!--
153TBD: Centered layout related settings
154```json
155    "centered_layout": {
156    // The relative width of the left padding of the central pane from the
157    // workspace when the centered layout is used.
158    "left_padding": 0.2,
159    // The relative width of the right padding of the central pane from the
160    // workspace when the centered layout is used.
161    "right_padding": 0.2
162    },
163```
164-->
165
166## Editor
167
168```json
169  // Whether the cursor blinks in the editor.
170  "cursor_blink": true,
171
172  // Cursor shape for the default editor: bar, block, underline, hollow
173  "cursor_shape": null,
174
175  // Highlight the current line in the editor: none, gutter, line, all
176  "current_line_highlight": "all",
177
178  // When does the mouse cursor hide: never, on_typing, on_typing_and_movement
179  "hide_mouse": "on_typing_and_movement",
180
181  // Whether to highlight all occurrences of the selected text in an editor.
182  "selection_highlight": true,
183
184  // Visually show tabs and spaces  (none, all, selection, boundary, trailing)
185  "show_whitespaces": "selection",
186
187  "unnecessary_code_fade": 0.3, // How much to fade out unused code.
188
189  // Hide the values of in variables from visual display in private files
190  "redact_private_values": false,
191
192  // Soft-wrap and rulers
193  "soft_wrap": "none",          // none, editor_width, preferred_line_length, bounded
194  "preferred_line_length": 80,  // Column to soft-wrap
195  "show_wrap_guides": true,     // Show/hide wrap guides (vertical rulers)
196  "wrap_guides": [],            // Where to position wrap_guides (character counts)
197
198  // Gutter Settings
199  "gutter": {
200    "line_numbers": true,         // Show/hide line numbers in the gutter.
201    "runnables": true,            // Show/hide runnables buttons in the gutter.
202    "breakpoints": true,          // Show/hide show breakpoints in the gutter.
203    "folds": true,                // Show/hide show fold buttons in the gutter.
204    "min_line_number_digits": 4   // Reserve space for N digit line numbers
205  },
206  "relative_line_numbers": false, // Show relative line numbers in gutter
207
208  // Indent guides
209  "indent_guides": {
210    "enabled": true,
211    "line_width": 1,                  // Width of guides in pixels [1-10]
212    "active_line_width": 1,           // Width of active guide in pixels [1-10]
213    "coloring": "fixed",              // disabled, fixed, indent_aware
214    "background_coloring": "disabled" // disabled, indent_aware
215  }
216```
217
218### Git Blame {#editor-blame}
219
220```json
221  "git": {
222    "inline_blame": {
223      "enabled": true,             // Show/hide inline blame
224      "delay": 0,                  // Show after delay (ms)
225      "min_column": 0,             // Minimum column to inline display blame
226      "padding": 7,                // Padding between code and inline blame (em)
227      "show_commit_summary": false // Show/hide commit summary
228    },
229    "hunk_style": "staged_hollow"  // staged_hollow, unstaged_hollow
230  }
231```
232
233### Editor Toolbar
234
235```json
236  // Editor toolbar related settings
237  "toolbar": {
238    "breadcrumbs": true, // Whether to show breadcrumbs.
239    "quick_actions": true, // Whether to show quick action buttons.
240    "selections_menu": true, // Whether to show the Selections menu
241    "agent_review": true, // Whether to show agent review buttons
242    "code_actions": false // Whether to show code action buttons
243  }
244```
245
246### Editor Scrollbar and Minimap {#editor-scrollbar}
247
248```json
249  // Scrollbar related settings
250  "scrollbar": {
251    // When to show the scrollbar in the editor (auto, system, always, never)
252    "show": "auto",
253    "cursors": true,          // Show cursor positions in the scrollbar.
254    "git_diff": true,         // Show git diff indicators in the scrollbar.
255    "search_results": true,   // Show buffer search results in the scrollbar.
256    "selected_text": true,    // Show selected text occurrences in the scrollbar.
257    "selected_symbol": true,  // Show selected symbol occurrences in the scrollbar.
258    "diagnostics": "all",     // Show diagnostics (none, error, warning, information, all)
259    "axes": {
260      "horizontal": true,     // Show/hide the horizontal scrollbar
261      "vertical": true        // Show/hide the vertical scrollbar
262    }
263  },
264
265  // Minimap related settings
266  "minimap": {
267    "show": "never",                // When to show (auto, always, never)
268    "display_in": "active_editor",  // Where to show (active_editor, all_editor)
269    "thumb": "always",              // When to show thumb (always, hover)
270    "thumb_border": "left_open",    // Thumb border (left_open, right_open, full, none)
271    "max_width_columns": 80,        // Maximum width of minimap
272    "current_line_highlight": null  // Highlight current line (null, line, gutter)
273  },
274
275  // Control Editor scroll beyond the last line: off, one_page, vertical_scroll_margin
276  "scroll_beyond_last_line": "one_page",
277  // Lines to keep above/below the cursor when scrolling with the keyboard
278  "vertical_scroll_margin": 3,
279  // The number of characters to keep on either side when scrolling with the mouse
280  "horizontal_scroll_margin": 5,
281  // Scroll sensitivity multiplier
282  "scroll_sensitivity": 1.0,
283  // Scroll sensitivity multiplier for fast scrolling (hold alt while scrolling)
284  "fast_scroll_sensitivity": 4.0,
285```
286
287### Editor Tabs
288
289```json
290  // Maximum number of tabs per pane. Unset for unlimited.
291  "max_tabs": null,
292
293  // Customize the tab bar appearance
294  "tab_bar": {
295    "show": true,                     // Show/hide the tab bar
296    "show_nav_history_buttons": true, // Show/hide history buttons on tab bar
297    "show_tab_bar_buttons": true      // Show hide buttons (new, split, zoom)
298  },
299  "tabs": {
300    "git_status": false,              // Color to show git status
301    "close_position": "right",        // Close button position (left, right, hidden)
302    "show_close_button": "hover",     // Close button shown (hover, always, hidden)
303    "file_icons": false,              // Icon showing file type
304    // Show diagnostics in file icon (off, errors, all). Requires file_icons=true
305    "show_diagnostics": "off"
306  }
307```
308
309### Multibuffer
310
311```json
312{
313  // The default number of lines to expand excerpts in the multibuffer by.
314  "expand_excerpt_lines": 5
315}
316```
317
318### Editor Completions, Snippets, Actions, Diagnostics {#editor-lsp}
319
320```json
321  "snippet_sort_order": "inline",        // Snippets completions: top, inline, bottom, none
322  "show_completions_on_input": true,     // Show completions while typing
323  "show_completion_documentation": true, // Show documentation in completions
324  "auto_signature_help": false,          // Show method signatures inside parentheses
325
326  // Whether to show the signature help after completion or a bracket pair inserted.
327  // If `auto_signature_help` is enabled, this setting will be treated as enabled also.
328  "show_signature_help_after_edits": false,
329
330  // Whether to show code action button at start of buffer line.
331  "inline_code_actions": true,
332
333  // Which level to use to filter out diagnostics displayed in the editor:
334  "diagnostics_max_severity": null,      // off, error, warning, info, hint, null (all)
335
336  // How to render LSP `textDocument/documentColor` colors in the editor.
337  "lsp_document_colors": "inlay",        // none, inlay, border, background
338```
339
340### Edit Predictions {#editor-ai}
341
342```json
343  "edit_predictions": {
344    "mode": "eager",                // Automatically show (eager) or hold-alt (subtle)
345    "enabled_in_text_threads": true // Show/hide predictions in agent text threads
346  },
347  "show_edit_predictions": true     // Show/hide predictions in editor
348```
349
350### Editor Inlay Hints
351
352```json
353{
354  "inlay_hints": {
355    "enabled": false,
356    // Toggle certain types of hints on and off, all switched on by default.
357    "show_type_hints": true,
358    "show_parameter_hints": true,
359    "show_other_hints": true,
360
361    // Whether to show a background for inlay hints (theme `hint.background`)
362    "show_background": false, //
363
364    // Time to wait after editing before requesting hints (0 to disable debounce)
365    "edit_debounce_ms": 700,
366    // Time to wait after scrolling before requesting hints (0 to disable debounce)
367    "scroll_debounce_ms": 50,
368
369    // A set of modifiers which, when pressed, will toggle the visibility of inlay hints.
370    "toggle_on_modifiers_press": {
371      "control": false,
372      "shift": false,
373      "alt": false,
374      "platform": false,
375      "function": false
376    }
377  }
378}
379```
380
381## File Finder
382
383```json
384  // File Finder Settings
385  "file_finder": {
386    "file_icons": true,         // Show/hide file icons
387    "modal_max_width": "small", // Horizontal size: small, medium, large, xlarge, full
388    "git_status": true,         // Show the git status for each entry
389    "include_ignored": null     // gitignored files in results: true, false, null
390  },
391```
392
393## Project Panel
394
395Project panel can be shown/hidden with {#action project_panel::ToggleFocus} ({#kb project_panel::ToggleFocus}) or with {#action pane::RevealInProjectPanel} ({#kb pane::RevealInProjectPanel}).
396
397```json
398  // Project Panel Settings
399  "project_panel": {
400    "button": true,                 // Show/hide button in the status bar
401    "default_width": 240,           // Default panel width
402    "dock": "left",                 // Position of the dock (left, right)
403    "entry_spacing": "comfortable", // Vertical spacing (comfortable, standard)
404    "file_icons": true,             // Show/hide file icons
405    "folder_icons": true,           // Show/hide folder icons
406    "git_status": true,             // Indicate new/updated files
407    "indent_size": 20,              // Pixels for each successive indent
408    "auto_reveal_entries": true,    // Show file in panel when activating its buffer
409    "auto_fold_dirs": true,         // Fold dirs with single subdir
410    "scrollbar": {                  // Project panel scrollbar settings
411      "show": null                  // Show/hide: (auto, system, always, never)
412    },
413    "show_diagnostics": "all",      //
414    // Settings related to indent guides in the project panel.
415    "indent_guides": {
416      // When to show indent guides in the project panel. (always, never)
417      "show": "always"
418    },
419    // Whether to hide the root entry when only one folder is open in the window.
420    "hide_root": false
421  }.
422```
423
424## Agent Panel
425
426```json
427  "agent": {
428    "version": "2",
429    "enabled": true,        // Enable/disable the agent
430    "button": true,         // Show/hide the icon in the status bar
431    "dock": "right",        // Where to dock: left, right, bottom
432    "default_width": 640,   // Default width (left/right docked)
433    "default_height": 320,  // Default height (bottom dockeed)
434  },
435  "agent_font_size": 16
436```
437
438See [Zed AI Documentation](./ai/overview.md) for additional non-visual AI settings.
439
440## Terminal Panel
441
442```json
443  // Terminal Panel Settings
444  "terminal": {
445    "dock": "bottom",                   // Where to dock: left, right, bottom
446    "button": true,                     // Show/hide status bar icon
447    "default_width": 640,               // Default width (left/right docked)
448    "default_height": 320,              // Default height (bottom dockeed)
449
450    // Set the cursor blinking behavior in the terminal (on, off, terminal_controlled)
451    "blinking": "terminal_controlled",
452    // Default cursor shape for the terminal cursor (block, bar, underline, hollow)
453    "cursor_shape": "block",
454
455    // Environment variables to add to terminal's process environment
456    "env": {
457      // "KEY": "value"
458    },
459
460    // Terminal scrollbar
461    "scrollbar": {
462      "show": null                       // Show/hide: (auto, system, always, never)
463    },
464    // Terminal Font Settings
465    "font_family": "Zed Plex Mono",
466    "font_size": 15,
467    "font_weight": 400,
468    // Terminal line height: comfortable (1.618), standard(1.3) or `{ "custom": 2 }`
469    "line_height": "comfortable",
470
471    "max_scroll_history_lines": 10000,   // Scrollback history (0=disable, max=100000)
472  }
473```
474
475See [Terminal settings](./configuring-zed.md#terminal) for additional non-visual customization options.
476
477### Other Panels
478
479```json
480  // Git Panel
481  "git_panel": {
482    "button": true,               // Show/hide status bar icon
483    "dock": "left",               // Where to dock: left, right
484    "default_width": 360,         // Default width of the git panel.
485    "status_style": "icon",       // label_color, icon
486    "sort_by_path": false,        // Sort by path (false) or status (true)
487    "scrollbar": {
488      "show": null                // Show/hide: (auto, system, always, never)
489    }
490  },
491
492  // Debugger Panel
493  "debugger": {
494    "dock": "bottom",             // Where to dock: left, right, bottom
495    "button": true                // Show/hide status bar icon
496  },
497
498  // Outline Panel
499  "outline_panel": {
500    "button": true,               // Show/hide status bar icon
501    "default_width": 300,         // Default width of the git panel
502    "dock": "left",               // Where to dock: left, right
503    "file_icons": true,           // Show/hide file_icons
504    "folder_icons": true,         // Show file_icons (true), chevrons (false) for dirs
505    "git_status": true,           // Show git status
506    "indent_size": 20,            // Indentation for nested items (pixels)
507    "indent_guides": {
508      "show": "always"            // Show indent guides (always, never)
509    },
510    "auto_reveal_entries": true,  // Show file in panel when activating its buffer
511    "auto_fold_dirs": true,       // Fold dirs with single subdir
512    "scrollbar": {                // Project panel scrollbar settings
513      "show": null                // Show/hide: (auto, system, always, never)
514    }
515  }
516```
517
518## Collaboration Panels
519
520```json
521{
522  // Collaboration Panel
523  "collaboration_panel": {
524    "button": true,               // Show/hide status bar icon
525    "dock": "left",               // Where to dock: left, right
526    "default_width": 240          // Default width of the collaboration panel.
527  },
528  "show_call_status_icon": true,  // Shown call status in the OS status bar.
529
530  // Chat Panel
531  "chat_panel": {
532    "button": "when_in_call",     // status bar icon (true, false, when_in_call)
533    "dock": "right",              // Where to dock: left, right
534    "default_width": 240          // Default width of the chat panel
535  },
536
537  // Notification Panel
538  "notification_panel": {
539    // Whether to show the notification panel button in the status bar.
540    "button": true,
541    // Where to dock the notification panel. Can be 'left' or 'right'.
542    "dock": "right",
543    // Default width of the notification panel.
544    "default_width": 380
545  }
546```