1
- *tabpage.txt* For Vim version 9.1. Last change: 2024 Jul 12
1
+ *tabpage.txt* For Vim version 9.1. Last change: 2025 May 30
2
2
3
3
4
4
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -14,7 +14,8 @@ when used in combination with more than one tab page.
14
14
2. Commands | tab-page-commands |
15
15
3. Other items | tab-page-other |
16
16
4. Setting 'tabline' | setting-tabline |
17
- 5. Setting 'guitablabel' | setting-guitablabel |
17
+ 5. Setting 'tabpanel' | setting-tabpanel |
18
+ 6. Setting 'guitablabel' | setting-guitablabel |
18
19
19
20
{not able to use multiple tab pages when the | +windows | feature was disabled
20
21
at compile time}
@@ -364,8 +365,8 @@ The 'tabline' option allows you to define your preferred way to tab pages
364
365
labels. This isn't easy, thus an example will be given here.
365
366
366
367
For basics see the 'statusline' option. The same items can be used in the
367
- 'tabline' option. Additionally, the | tabpagebuflist() | , | tabpagenr() | and
368
- | tabpagewinnr() | functions are useful.
368
+ 'tabline' and 'tabpanel' option. Additionally, the | tabpagebuflist() | ,
369
+ | tabpagenr() | and | tabpagewinnr() | functions are useful.
369
370
370
371
Since the number of tab labels will vary, you need to use an expression for
371
372
the whole option. Something like: >
@@ -418,7 +419,74 @@ clever way when there is not enough room. Check the 'columns' option for the
418
419
space available.
419
420
420
421
==============================================================================
421
- 5. Setting 'guitablabel' *setting-guitablabel*
422
+ 5. Setting 'tabpanel' *tabpanel* *setting-tabpanel*
423
+
424
+ The tabpanel is a vertical sidebar that displays tab page labels along the
425
+ side of the window. It looks like this:
426
+ >
427
+ +-----------+----------------------------------
428
+ |(1) |text text text text text text text
429
+ | ~/aaa.txt|text text text text text text text
430
+ |(2) |text text text text text text text
431
+ | ~/.vimrc |text text text text text text text
432
+ |(3) |text text text text text text text
433
+ | ~/bbb.js |text text text text text text text
434
+ | ~/ccc.css|text text text text text text text
435
+ | |text text text text text text text
436
+ | |text text text text text text text
437
+ | |text text text text text text text
438
+ <
439
+ To configure the tabpanel, use the following options: 'tabpanel' ,
440
+ 'showtabpanel' and 'tabpanelopt' .
441
+ The 'tabpanel' and 'showtabpanel' options function similar to
442
+ 'statusline' or 'tabline' .
443
+
444
+ The "columns:" of 'tabpanelopt' option specifies the width of the tabpanel:
445
+ >
446
+ +------ This width
447
+ |
448
+ <----+----->
449
+ +-----------+----------------------------------
450
+ |(1) |text text text text text text text
451
+ | ~/aaa.txt|text text text text text text text
452
+ |(2) |text text text text text text text
453
+ <
454
+ The "align:" of 'tabpanelopt' option determines whether the tabpanel is
455
+ displayed on the right side of the window:
456
+ >
457
+ +----------------------------------+-----------
458
+ |text text text text text text text|(1)
459
+ |text text text text text text text| ~/aaa.txt
460
+ |text text text text text text text|(2)
461
+ <
462
+ The "wrap" of 'tabpanelopt' option controls whether lines in tabpanel are
463
+ wraped:
464
+ >
465
+ +-----------+----------------------------------
466
+ |(1) |text text text text text text text
467
+ | ~/long_lo|text text text text text text text
468
+ |ng_file_nam|text text text text text text text
469
+ |e.txt |text text text text text text text
470
+ |(2) |text text text text text text text
471
+
472
+ The "vert" of 'tabpanelopt' option defines whether a vertical separator is
473
+ displayed between the tabpanel and the main window:
474
+ >
475
+ +------ This is
476
+ |
477
+ v
478
+ +-----------+----------------------------------
479
+ |(1) |text text text text text text text
480
+ | ~/aaa.txt|text text text text text text text
481
+ |(2) |text text text text text text text
482
+ <
483
+ The vertical separator used is "tpl_vert" of 'fillchars' .
484
+
485
+ You can customize the appearance of the tab page labels using the highlight
486
+ groups: | hl-TabPanel | | hl-TabPanelSel | | hl-TabPanelFill |
487
+
488
+ ==============================================================================
489
+ 6. Setting 'guitablabel' *setting-guitablabel*
422
490
423
491
When the GUI tab pages line is displayed, 'guitablabel' can be used to
424
492
specify the label to display for each tab page. Unlike 'tabline' , which
0 commit comments