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