visual-customization.md

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