-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathscrollview.txt
1270 lines (1082 loc) · 63.2 KB
/
scrollview.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
*scrollview.txt* Plugin that shows interactive vertical scrollbars and signs
*nvim-scrollview*
Author: Daniel Steinberg - https://www.dannyadam.com
Web: https://github.com/dstein64/nvim-scrollview
1. Requirements |scrollview-requirements|
2. Installation |scrollview-installation|
3. Usage |scrollview-usage|
4. Configuration |scrollview-configuration|
5. Sign Extensibility |scrollview-signs-extensibility|
6. Issues |scrollview-issues|
|nvim-scrollview| is a plugin that displays interactive vertical scrollbars and
signs. The plugin is customizable (see |scrollview-configuration|).
Type |gO| to see the table of contents.
============================================================================
1. Requirements *scrollview-requirements*
* `nvim>=0.6`
* Scrollbar mouse functionality requires mouse support (see |'mouse'|)
* Signs require `nvim>=0.9`
============================================================================
2. Installation *scrollview-installation*
Use |packages| or one of the various package managers.
============================================================================
3. Usage *scrollview-usage*
* |nvim-scrollview| works automatically, displaying interactive scrollbars and
signs.
*scrollview-mouse*
The scrollbars are draggable with a mouse. Signs can be clicked for navigation
or right-clicked for information. If |'mousemoveevent'| is set, scrollbars and
signs are highlighted when the mouse pointer hovers.
*scrollview-commands*
*:ScrollViewDisable*
:ScrollViewDisable Disable the plugin.
:ScrollViewDisable {group1} ...
Disable the specified sign groups.
*:ScrollViewEnable*
:ScrollViewEnable Enable the plugin. This is only necessary if
nvim-scrollview has previously been disabled.
:ScrollViewEnable {group1} ...
Enable the specified sign groups.
*:ScrollViewToggle*
:ScrollViewToggle Toggle the plugin.
:ScrollViewToggle {group1} ...
Toggle the specified sign groups.
*:ScrollViewRefresh*
:ScrollViewRefresh Refresh the scrollbars and signs. This is relevant when
the state becomes out-of-sync, which can occur e.g., as
a result of some window arrangement actions (see
|scrollview-issues|).
:ScrollViewLegend[!] [{group1} ...] *:ScrollViewLegend*
Show a legend for the scrollbar and signs. The optional
trailing arguments specify which sign groups are
considered (all groups when not specified). Without
[!], the legend will only contain items that are
currently visible. With [!], the legend will include
the scrollbar and all registered signs (even those from
disabled groups), regardless of their display status.
:[count]ScrollViewNext [{group1} ...] *:ScrollViewNext*
Move the cursor to the [count]'th next line with a
sign. If the |'wrapscan'| option is set, the movement
wraps around the end of the buffer when necessary.
Otherwise, the movement stops at the last line with a
sign. The optional trailing arguments specify which
sign groups are considered (all groups when not
specified).
:[count]ScrollViewPrev [{group1} ...] *:ScrollViewPrev*
Move the cursor to the [count]'th previous line with
a sign. If the |'wrapscan'| option is set, the movement
wraps around the beginning of the buffer when
necessary. Otherwise, the movement stops at the first
line with a sign. The optional trailing arguments
specify which sign groups are considered (all groups
when not specified).
:ScrollViewFirst [{group1} ...] *:ScrollViewFirst*
Move the cursor to the first line with a sign. The
optional trailing arguments specify which sign groups
are considered (all groups when not specified).
:ScrollViewLast [{group1} ...] *:ScrollViewLast*
Move the cursor to the last line with a sign. The
optional trailing arguments specify which sign groups
are considered (all groups when not specified).
*scrollview-mappings*
The following |<Plug>| mappings are defined for convenience.
* `<Plug>(ScrollViewDisable)`
* `<Plug>(ScrollViewEnable)`
* `<Plug>(ScrollViewFirst)`
* `<Plug>(ScrollViewLast)`
* `<Plug>(ScrollViewLegend)`
* `<Plug>(ScrollViewLegend!)`
* `<Plug>(ScrollViewNext)`
* `<Plug>(ScrollViewPrev)`
* `<Plug>(ScrollViewRefresh)`
* `<Plug>(ScrollViewToggle)`
*scrollview-enabled-global*
*scrollview_enabled*
A global variable, `scrollview_enabled`, is set to |v:true| when the plugin is
enabled, and |v:false| otherwise. It can be accessed from Lua
(`vim.g.scrollview_enabled`) or Vimscript (`g:scrollview_enabled`). Do not
modify its value; it should be treated as read-only. Use |:ScrollViewEnable|,
|:ScrollViewDisable|, and |:ScrollViewToggle| to enable, disable, or toggle
the plugin.
*scrollview-refreshing-global*
*scrollview_refreshing*
A global variable, `scrollview_refreshing`, is set to |v:true| while scrollbars
are being refreshed, and |v:false| otherwise. It can be accessed from Lua
(`vim.g.scrollview_refreshing`) or Vimscript (`g:scrollview_refreshing`).
The plugin executes commands with `:normal!`, which are treated as if they are
typed. `scrollview_refreshing` may be useful for ignoring the corresponding keys
when using |vim.on_key()|.
>
vim.on_key(function(char)
if vim.g.scrollview_refreshing then return end
...
end)
<
*scrollview-signs*
|nvim-scrollview| signs are similar to Neovim's built-in |signs|, but with
positioning logic matching that of the scrollbar. The plugin includes a set
of built-in sign groups (e.g., `search` signs show where in the document there
are search matches).
For configuring signs generally, and the built-in groups specifically, see
|scrollview-signs-configuration|. For extending sign functionality (e.g., in a
Neovim configuration file or with a plugin), see
|scrollview-signs-extensibility|.
When there are multiple signs displayed on the same row, they will be
positioned based on their priority. The higher the priority of a sign, which
is configurable, the closer it will be to the scrollbar. When the number of
signs exceeds the value specified by |scrollview_signs_max_per_row|, the lower
priority signs will be dropped.
Clicking on a sign will navigate to its associated line. If a sign is linked
to multiple lines, successive clicks will cycle through these lines.
Right-clicking a sign reveals additional information, including its sign group
and the corresponding lines, which can be selected for navigation. Identifying
the sign group can be helpful if you are unsure what a sign represents.
Built-in Sign Groups ~
*scrollview-signs-built-in*
Group Information
----- -----------
`changelist` change list items (previous, current, and next)
`conflicts` git merge conflicts
`cursor` cursor position
`diagnostics` errors, warnings, info, and hints via |vim.diagnostic|
`folds` closed folds
`indent` unexpected indentation characters (e.g., tabs when |expandtab|
is set)
`latestchange` latest change
`keywords` FIX, FIXME, HACK, TODO, WARN, WARNING, and XXX (see
|scrollview-signs-keywords| for customization info)
`loclist` items on the location list
`marks`
`quickfix` items on the quickfix list
`search`
`spell` spell check items when the |'spell'| option is enabled
`textwidth` line lengths exceeding the value of the |'textwidth'| option, when
non-zero
`trail` trailing whitespace
*scrollview-restricted*
Under certain scenarios, the plugin enters a restricted mode to prevent a
slowdown. Under restricted operation, the |scrollview-mode| is set to `simple`
and signs are not displayed. |scrollview_byte_limit| and |scrollview_line_limit|
can be set to control when restricted mode is entered.
============================================================================
4. Configuration *scrollview-configuration*
Configuration Variables ~
*scrollview_base*
scrollview_base |String| specifying where the scrollbar is anchored.
Possible values are `'left'` or `'right'` for corresponding
window edges, or `'buffer'`. Defaults to `'right'`.
*scrollview_byte_limit*
scrollview_byte_limit |Number| specifying the buffer size threshold (in
bytes) for entering restricted mode, to prevent slow
operation. Defaults to `1,000,000`. Use `-1` for no limit.
*scrollview_character*
scrollview_character |String| specifying a character to display on scrollbars.
Defaults to `''`. Scrollbar transparency (via
|scrollview_winblend|) is not possible when a scrollbar
character is used.
*scrollview_column*
scrollview_column |Number| specifying the scrollbar column (relative to
|scrollview_base|). Defaults to `1`. Must be an integer
greater than or equal to `1`.
scrollview_consider_border *scrollview_consider_border*
(experimental) |Boolean| specifying whether floating window borders are
taken into account for positioning scrollbars and signs.
When set to |v:true|, borders are considered as part of
the window; scrollbars and signs can be positioned
where there are borders. When set to |v:false|, borders
are ignored. Defaults to |v:false|. The setting is only
applicable for floating windows that have borders, and
only relevant when |scrollview_floating_windows| is
turned on and |scrollview_base| is set to `'left'` or
`'right'`.
scrollview_current_only *scrollview_current_only*
|Boolean| specifying whether scrollbars and signs should
only be displayed in the current window. Defaults to
|v:false|.
scrollview_excluded_filetypes *scrollview_excluded_filetypes*
|List| of |String|s specifying optional file types for
which scrollbars should not be displayed. Defaults to
`[]`.
scrollview_excluded_info_signs *scrollview_excluded_info_signs*
|List| of |String|s specifying sign groups to exclude from
visibility consideration when |scrollview_visibility| is
set to `'info'` and there is no overflow. Defaults to
`['changelist', 'cursor', 'latestchange']`.
scrollview_floating_windows *scrollview_floating_windows*
(experimental) |Boolean| specifying whether scrollbars and signs are
shown in floating windows. Defaults to |v:false|.
scrollview_hide_bar_for_insert *scrollview_hide_bar_for_insert*
|Boolean| specifying whether the scrollbar is hidden in
the current window for insert mode. Defaults to |v:false|.
See |scrollview_signs_hidden_for_insert| for hiding signs.
scrollview_hide_on_cursor_intersect *scrollview_hide_on_cursor_intersect*
|Boolean| specifying whether each scrollbar or sign
becomes hidden (not shown) when it would otherwise
intersect with the cursor. Defaults to |v:false|.
Requires `nvim>=0.7`.
scrollview_hide_on_float_intersect *scrollview_hide_on_float_intersect*
|Boolean| specifying whether each scrollbar or sign
becomes hidden (not shown) when it would otherwise
intersect with a floating window. Defaults to |v:false|.
scrollview_hide_on_text_intersect *scrollview_hide_on_text_intersect*
(experimental) |Boolean| specifying whether each scrollbar or sign
becomes hidden (not shown) when it would otherwise
intersect with text (excluding virtual text). The
functionality may not work for lines where the last
character spans multiple cells (only the first cell of
the character would be considered for intersection).
For lines with concealed text, signs and the scrollbar
can become hidden when they don't intersect text. The
processing demands when enabling this option may result
in noticeable lag under certain environments,
especially on older hardware. Defaults to |v:false|.
scrollview_hover *scrollview_hover*
|Boolean| specifying whether the highlighting of
scrollbars and signs should change when hovering with
the mouse. Requires mouse support (see |'mouse'|) with
|'mousemoveevent'| set. Defaults to |v:true|.
scrollview_include_end_region *scrollview_include_end_region*
|Boolean| specifying whether the region beyond the last
line is considered as containing ordinary lines for the
calculation of scrollbar height and positioning.
Defaults to |v:false|. See Issue #58 for details.
*scrollview_line_limit*
scrollview_line_limit |Number| specifying the buffer size threshold (in
lines) for entering restricted mode, to prevent slow
operation. Defaults to `20,000`. Use `-1` for no limit.
*scrollview_mode*
scrollview_mode |String| specifying what the scrollbar position and size
correspond to. See |scrollview-modes| for details on the
available modes. Defaults to `'auto'`.
scrollview_mouse_primary *scrollview_mouse_primary*
|String| specifying the button for primary mouse
operations (dragging scrollbars and clicking signs).
Possible values include `'left'`, `'middle'`, `'right'`,
`'x1'`, and `'x2'`. These can be prepended with `'c-'` or
`'m-'` for the control-key and alt-key variants (e.g.,
`'c-left'` for control-left). Set to `v:null` to disable
the functionality. Defaults to `'left'`. For `nvim<0.11`,
an existing mapping will not be clobbered, unless `'!'`
is added at the end (e.g., `'left!'`). For `nvim<0.11`,
the option is considered only when the plugin is loaded.
scrollview_mouse_secondary *scrollview_mouse_secondary*
|String| specifying the button for secondary mouse
operations (clicking signs for additional information).
See |scrollview_mouse_primary| for the possible values,
including how `'c-'`, `'m-'`, and `v:null` can be utilized,
as well as the behavior specific to `nvim<0.11`. Defaults
to `'right'`.
*scrollview_on_startup*
scrollview_on_startup |Boolean| specifying whether scrollbars are enabled on
startup. Defaults to |v:true|. Considered only when the
plugin is loaded.
*scrollview_visibility*
scrollview_visibility |String| specifying the visibility level of scrollbars
and signs. Possible values are `'always'`, `'overflow'`,
and `'info'`. Defaults to `'overflow'`.
* `always` Always show scrollbars and signs.
* `overflow` Show scrollbars and signs only when content
overflows the window (when there are lines that are
not visible).
* `info` Show scrollbars and signs when content overflows
the window. Otherwise, show when there are signs to
display (excluding those from sign groups included in
|scrollview_excluded_info_signs|).
*scrollview_winblend*
scrollview_winblend |Number| specifying the level of transparency for
scrollbars when a GUI is not running and 'termguicolors'
is not set. Defaults to `50`. Must be between `0` (opaque)
and `100` (transparent). This option is ignored for
scrollview windows whose highlight group has 'reverse'
or 'inverse' specified as a cterm attribute; see
|attr-list|. Such windows will have no transparency, as a
workaround for Neovim #24159. This option is ignored
for scrollview windows shown for floating windows; see
|scrollview_floating_windows|. Such windows will have no
transparency, as a workaround for Neovim #14624.
scrollview_winblend_gui *scrollview_winblend_gui*
(experimental) |Number| specifying the level of transparency for
scrollbars when a GUI is running or 'termguicolors' is
set. Defaults to `0`. Must be between `0` (opaque) and `100`
(transparent). This option is ignored for scrollview
windows whose highlight group has 'reverse' or 'inverse'
specified as a gui attribute; see |attr-list|. Such
windows will have no transparency, as a workaround for
Neovim #24159. This option is ignored for scrollview
windows shown for floating windows; see
|scrollview_floating_windows|. Such windows will have no
transparency, as a workaround for Neovim #14624. This
option can interact with highlight settings
(|scrollview-color-customization|); careful adjustment of
the winblend setting and highlighting may be necessary
to achieve the desired result.
scrollview_zindex *scrollview_zindex*
|Number| specifying the z-index for scrollbars and signs.
Must be larger than zero. Defaults to `40`.
*scrollview-signs-configuration*
Sign Configuration Variables ~
scrollview_signs_hidden_for_insert *scrollview_signs_hidden_for_insert*
|List| of |String|s specifying sign groups to hide in the
current window for insert mode. Set to `['all']` to hide
all sign groups. Defaults to `[]`. See
|scrollview_hide_bar_for_insert| for hiding the scrollbar.
scrollview_signs_max_per_row *scrollview_signs_max_per_row*
|Number| specifying the maximum number of signs per row.
Set to `-1` to have no limit. Defaults to `-1`.
scrollview_signs_on_startup *scrollview_signs_on_startup*
|List| of |String|s specifying built-in sign groups to
enable on startup. Set to `[]` to disable all built-in
sign groups on startup. Set to `['all']` to enable all
sign groups. `['diagnostics', 'search']` is the default
for `nvim<0.10`. `['diagnostics', 'marks', 'search']` is
the default for `nvim>=0.10`. Considered only when the
plugin is loaded.
scrollview_signs_overflow *scrollview_signs_overflow*
|String| specifying the sign overflow direction (to
avoid overlapping the scrollbar or other signs).
Possible values are `'left'` or `'right'`. Defaults to
`'left'`.
scrollview_signs_show_in_folds *scrollview_signs_show_in_folds*
|Boolean| specifying whether signs on lines within hidden
folds should be shown. Sign groups can override this
setting (e.g., the built-in cursor sign group does).
Defaults to |v:false|.
*scrollview-signs-built-in-config*
Configuration Variables for Built-in Sign Groups ~
scrollview_changelist_previous_priority *scrollview_changelist_previous_priority*
|Number| specifying the priority for the previous item
changelist sign. Defaults to `15`. Considered only when
the plugin is loaded.
scrollview_changelist_previous_symbol *scrollview_changelist_previous_symbol*
|String| specifying the symbol for the previous item
changelist sign. Defaults to an upwards arrow with tip
leftwards. Considered only when the plugin is loaded.
scrollview_changelist_current_priority *scrollview_changelist_current_priority*
|Number| specifying the priority for the current item
changelist sign. Defaults to `10`. Considered only when
the plugin is loaded.
scrollview_changelist_current_symbol *scrollview_changelist_current_symbol*
|String| specifying the symbol for the current item
changelist sign. Defaults to `'@'`. Considered only when
the plugin is loaded.
scrollview_changelist_next_priority *scrollview_changelist_next_priority*
|Number| specifying the priority for the next item
changelist sign. Defaults to `5`. Considered only when
the plugin is loaded.
scrollview_changelist_next_symbol *scrollview_changelist_next_symbol*
|String| specifying the symbol for the next item
changelist sign. Defaults to a downwards arrow with tip
rightwards. Considered only when the plugin is loaded.
scrollview_conflicts_bottom_priority *scrollview_conflicts_bottom_priority*
|Number| specifying the priority for conflict bottom
signs. Defaults to `80`. Considered only when the
plugin is loaded.
scrollview_conflicts_bottom_symbol *scrollview_conflicts_bottom_symbol*
|String| specifying the symbol for conflict bottom signs.
Defaults to `'>'`. A |List| of |String|s can also be
used; the symbol is selected using the index equal to
the number of lines corresponding to the sign, or the
last element when the retrieval would be out-of-bounds.
Considered only when the plugin is loaded.
scrollview_conflicts_middle_priority *scrollview_conflicts_middle_priority*
|Number| specifying the priority for conflict middle
signs. Defaults to `75`. Considered only when the plugin
is loaded.
scrollview_conflicts_middle_symbol *scrollview_conflicts_middle_symbol*
|String| specifying the symbol for conflict middle signs.
Defaults to `'='`. A |List| of |String|s can also be used;
the symbol is selected using the index equal to the
number of lines corresponding to the sign, or the last
element when the retrieval would be out-of-bounds.
Considered only when the plugin is loaded.
scrollview_conflicts_top_priority *scrollview_conflicts_top_priority*
|Number| specifying the priority for conflict top signs.
Defaults to `70`. Considered only when the plugin is
loaded.
scrollview_conflicts_top_symbol *scrollview_conflicts_top_symbol*
|String| specifying the symbol for conflict top signs.
Defaults to `'<'`. A |List| of |String|s can also be used;
the symbol is selected using the index equal to the
number of lines corresponding to the sign, or the last
element when the retrieval would be out-of-bounds.
Considered only when the plugin is loaded.
scrollview_cursor_priority *scrollview_cursor_priority*
|Number| specifying the priority for cursor signs.
Defaults to `0`. Considered only when the plugin is
loaded.
scrollview_cursor_symbol *scrollview_cursor_symbol*
|String| specifying the symbol for cursor signs. Defaults
to a small square, resembling a block cursor.
Considered only when the plugin is loaded.
scrollview_diagnostics_error_priority *scrollview_diagnostics_error_priority*
|Number| specifying the priority for diagnostic error
signs. Defaults to `60`. Considered only when the plugin
is loaded.
scrollview_diagnostics_error_symbol *scrollview_diagnostics_error_symbol*
|String| specifying the symbol for diagnostic error
signs. Defaults to the trimmed sign text for
DiagnosticSignError if defined, or `'E'` otherwise. A
|List| of |String|s can also be used; the symbol is
selected using the index equal to the number of lines
corresponding to the sign, or the last element when the
retrieval would be out-of-bounds. Considered only when
the plugin is loaded.
scrollview_diagnostics_hint_priority *scrollview_diagnostics_hint_priority*
|Number| specifying the priority for diagnostic hint
signs. Defaults to `30`. Considered only when the
plugin is loaded.
scrollview_diagnostics_hint_symbol *scrollview_diagnostics_hint_symbol*
|String| specifying the symbol for diagnostic hint signs.
Defaults to the trimmed sign text for DiagnosticSignHint
if defined, or `'H'` otherwise. A |List| of |String|s can
also be used; the symbol is selected using the index
equal to the number of lines corresponding to the sign,
or the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_diagnostics_info_priority *scrollview_diagnostics_info_priority*
|Number| specifying the priority for diagnostic info
signs. Defaults to `40`. Considered only when the plugin
is loaded.
scrollview_diagnostics_info_symbol *scrollview_diagnostics_info_symbol*
|String| specifying the symbol for diagnostic info signs.
Defaults to the trimmed sign text for DiagnosticSignInfo
if defined, or `'I'` otherwise. A |List| of |String|s can
also be used; the symbol is selected using the index
equal to the number of lines corresponding to the sign,
or the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_diagnostics_severities *scrollview_diagnostics_severities*
|List| of |Number|s specifying the diagnostic severities
for which signs will be shown. The default includes
|vim.diagnostic.severity.ERROR|, |vim.diagnostic.severity.HINT|,
|vim.diagnostic.severity.INFO|, and |vim.diagnostic.severity.WARN|.
Considered only when the plugin is loaded.
scrollview_diagnostics_warn_priority *scrollview_diagnostics_warn_priority*
|Number| specifying the priority for diagnostic warn
signs. Defaults to `50`. Considered only when the plugin
is loaded.
scrollview_diagnostics_warn_symbol *scrollview_diagnostics_warn_symbol*
|String| specifying the symbol for diagnostic warn signs.
Defaults to the trimmed sign text for DiagnosticSignWarn
if defined, or `'W'` otherwise. A |List| of |String|s can
also be used; the symbol is selected using the index
equal to the number of lines corresponding to the sign,
or the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_folds_priority *scrollview_folds_priority*
|Number| specifying the priority for fold signs. Defaults
to `30`. Considered only when the plugin is loaded.
scrollview_folds_symbol *scrollview_folds_symbol*
|String| specifying the symbol for fold signs. Defaults
to a right-pointing triangle. A |List| of |String|s can
also be used; the symbol is selected using the index
equal to the number of lines corresponding to the sign,
or the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_indent_spaces_condition *scrollview_indent_spaces_condition*
|String| specifying the condition when signs will be
shown for leading spaces. Possible values are `'always'`
`'never'`, `'expandtab'`, and `'noexpandtab'`. Defaults to
`'noexpandtab'`, which will show signs for leading
spaces when the |expandtab| option is off.
scrollview_indent_spaces_priority *scrollview_indent_spaces_priority*
|Number| specifying the priority for indent spaces signs.
Defaults to `25`. Considered only when the plugin is
loaded.
scrollview_indent_spaces_symbol *scrollview_indent_spaces_symbol*
|String| specifying the symbol for indent spaces signs.
Defaults to `'-'`. Considered only when the plugin is
loaded.
scrollview_indent_tabs_condition *scrollview_indent_tabs_condition*
|String| specifying the condition when signs will be
shown for leading tabs. Possible values are `'always'`
`'never'`, `'expandtab'`, and `'noexpandtab'`. Defaults to
`'expandtab'`, which will show signs for leading
tabs when the |expandtab| option is set.
scrollview_indent_tabs_priority *scrollview_indent_tabs_priority*
|Number| specifying the priority for indent tabs signs.
Defaults to `25`. Considered only when the plugin is
loaded.
scrollview_indent_tabs_symbol *scrollview_indent_tabs_symbol*
|String| specifying the symbol for indent tabs signs.
Defaults to `'>'`. Considered only when the plugin is
loaded.
scrollview_keywords_built_ins *scrollview_keywords_built_ins*
|List| of |String|s specifying the enabled built-in
keyword groups for the keyword sign group (see
|scrollview-signs-keywords|). Defaults to `['fix', 'hack',`
`'todo', 'warn', 'xxx']`. Considered only when the plugin
is loaded.
scrollview_keywords_fix_priority *scrollview_keywords_fix_priority*
|Number| specifying the priority for fix keyword signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_keywords_fix_scope *scrollview_keywords_fix_scope*
|String| specifying the search scope for fix keyword
signs. See |scrollview-signs-keyword-scopes| for details.
Defaults to `'auto'`. Considered only when the plugin is
loaded.
scrollview_keywords_fix_symbol *scrollview_keywords_fix_symbol*
|String| specifying the symbol for fix keyword signs.
Defaults to `'F'`. Considered only when the plugin is
loaded.
scrollview_keywords_hack_priority *scrollview_keywords_hack_priority*
|Number| specifying the priority for hack keyword signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_keywords_hack_scope *scrollview_keywords_hack_scope*
|String| specifying the search scope for hack keyword
signs. See |scrollview-signs-keyword-scopes| for details.
Defaults to `'auto'`. Considered only when the plugin is
loaded.
scrollview_keywords_hack_symbol *scrollview_keywords_hack_symbol*
|String| specifying the symbol for hack keyword signs.
Defaults to `'H'`. Considered only when the plugin is
loaded.
scrollview_keywords_todo_priority *scrollview_keywords_todo_priority*
|Number| specifying the priority for todo keyword signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_keywords_todo_scope *scrollview_keywords_todo_scope*
|String| specifying the search scope for todo keyword
signs. See |scrollview-signs-keyword-scopes| for details.
Defaults to `'auto'`. Considered only when the plugin is
loaded.
scrollview_keywords_todo_symbol *scrollview_keywords_todo_symbol*
|String| specifying the symbol for todo keyword signs.
Defaults to `'T'`. Considered only when the plugin is
loaded.
scrollview_keywords_warn_priority *scrollview_keywords_warn_priority*
|Number| specifying the priority for warn keyword signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_keywords_warn_scope *scrollview_keywords_warn_scope*
|String| specifying the search scope for warn keyword
signs. See |scrollview-signs-keyword-scopes| for details.
Defaults to `'auto'`. Considered only when the plugin is
loaded.
scrollview_keywords_warn_symbol *scrollview_keywords_warn_symbol*
|String| specifying the symbol for warn keyword signs.
Defaults to `'W'`. Considered only when the plugin is
loaded.
scrollview_keywords_xxx_priority *scrollview_keywords_xxx_priority*
|Number| specifying the priority for xxx keyword signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_keywords_xxx_scope *scrollview_keywords_xxx_scope*
|String| specifying the search scope for xxx keyword
signs. See |scrollview-signs-keyword-scopes| for details.
Defaults to `'auto'`. Considered only when the plugin is
loaded.
scrollview_keywords_xxx_symbol *scrollview_keywords_xxx_symbol*
|String| specifying the symbol for xxx keyword signs.
Defaults to `'X'`. Considered only when the plugin is
loaded.
scrollview_latestchange_priority *scrollview_latestchange_priority*
|Number| specifying the priority for latestchange signs.
Defaults to `10`. Considered only when the plugin is
loaded.
scrollview_latestchange_symbol *scrollview_latestchange_symbol*
|String| specifying the symbol for latestchange signs.
Defaults to a Greek uppercase delta. Considered only
when the plugin is loaded.
scrollview_loclist_priority *scrollview_loclist_priority*
|Number| specifying the priority for loclist signs.
Defaults to `45`. Considered only when the plugin is
loaded.
scrollview_loclist_symbol *scrollview_loclist_symbol*
|String| specifying the symbol for loclist signs.
Defaults to a small circle. A |List| of |String|s can also
be used; the symbol is selected using the index equal
to the number of lines corresponding to the sign, or
the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_marks_characters *scrollview_marks_characters*
|List| of |String|s specifying characters for which mark
signs will be shown. Defaults to characters `a-z` and
`A-Z`. Considered only when the plugin is loaded.
scrollview_marks_priority *scrollview_marks_priority*
|List| specifying the priority for mark signs. Defaults
to `50`. Considered only when the plugin is loaded.
scrollview_quickfix_priority *scrollview_quickfix_priority*
|Number| specifying the priority for quickfix signs.
Defaults to `45`. Considered only when the plugin is
loaded.
scrollview_quickfix_symbol *scrollview_quickfix_symbol*
|String| specifying the symbol for quickfix signs.
Defaults to a small circle. A |List| of |String|s can also
be used; the symbol is selected using the index equal
to the number of lines corresponding to the sign, or
the last element when the retrieval would be
out-of-bounds. Considered only when the plugin is
loaded.
scrollview_search_priority *scrollview_search_priority*
|Number| specifying the priority for search signs.
Defaults to `70`. Considered only when the plugin is
loaded.
scrollview_search_symbol *scrollview_search_symbol*
|String| specifying the symbol for search signs. A |List|
of |String|s can also be used; the symbol is selected
using the index equal to the number of lines
corresponding to the sign, or the last element when the
retrieval would be out-of-bounds. Defaults to ['=',
'=', nr2char(0x2261)], where the third element is the
triple bar. Considered only when the plugin is loaded.
scrollview_spell_priority *scrollview_spell_priority*
|Number| specifying the priority for spell signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_spell_symbol *scrollview_spell_symbol*
|String| specifying the symbol for spell signs. Defaults
to `'~'`. A |List| of |String|s can also be used; the symbol
is selected using the index equal to the number of
lines corresponding to the sign, or the last element
when the retrieval would be out-of-bounds. Considered
only when the plugin is loaded.
scrollview_textwidth_priority *scrollview_textwidth_priority*
|Number| specifying the priority for textwidth signs.
Defaults to `20`. Considered only when the plugin is
loaded.
scrollview_textwidth_symbol *scrollview_textwidth_symbol*
|String| specifying the symbol for textwidth signs.
Defaults to a right-pointing double angle quotation
mark. A |List| of |String|s can also be used; the symbol is
selected using the index equal to the number of lines
corresponding to the sign, or the last element when the
retrieval would be out-of-bounds. Considered only when
the plugin is loaded.
scrollview_trail_priority *scrollview_trail_priority*
|Number| specifying the priority for trail signs.
Defaults to `50`. Considered only when the plugin is
loaded.
scrollview_trail_symbol *scrollview_trail_symbol*
|String| specifying the symbol for trail signs. Defaults
to an outlined square. A |List| of |String|s can also be
used; the symbol is selected using the index equal to
the number of lines corresponding to the sign, or the
last element when the retrieval would be out-of-bounds.
Considered only when the plugin is loaded.
Configuration Example ~
*scrollview-configuration-example*
The variables can be customized in your |init.vim|, as shown in the following
example.
>
let g:scrollview_excluded_filetypes = ['nerdtree']
let g:scrollview_current_only = v:true
" Position the scrollbar at the 80th character of the buffer
let g:scrollview_base = 'buffer'
let g:scrollview_column = 80
" Enable all sign groups (defaults to ['diagnostics', 'search'])
let g:scrollview_signs_on_startup = ['all']
Lua Configuration ~
*scrollview.setup()*
A Lua `setup()` function is provided for convenience, to set globally scoped
options (the 'scrollview_' prefix is omitted). For example:
>
require('scrollview').setup({
excluded_filetypes = {'nerdtree'},
current_only = true,
-- Position the scrollbar at the 80th character of the buffer
base = 'buffer',
column = 80,
signs_on_startup = {'all'}
})
Alternatively, configuration variables can be set without calling `setup()`.
>
vim.g.scrollview_excluded_filetypes = {'nerdtree'},
vim.g.scrollview_current_only = true,
-- Position the scrollbar at the 80th character of the buffer
vim.g.scrollview_base = 'buffer',
vim.g.scrollview_column = 80,
vim.g.scrollview_signs_on_startup = {'all'}
Scrollview Modes ~
*scrollview-modes*
The following modes are available for the |scrollview_mode| configuration
setting (set as a |string|). Without (1) closed |folds|, (2) wrapped lines,
(3) diff filler, and (4) virtual text lines, all modes work the same way.
Mode Description
---- -----------
`simple` The scrollbar top position reflects the window's top line number
relative to the document's line count. The scrollbar height
reflects the size of the window relative to the document's line
count. Dragging the scrollbars with the mouse may result in
unresponsive scrolling when there are closed folds.
`virtual` The scrollbar position and height are calculated similarly as for
`simple` mode, but line numbers and the document line count are
implicitly updated to virtual counterparts that account for closed
folds. The scrollbar top position reflects the window's top virtual
line number relative to the document's virtual line count. The
scrollbar height reflects the size of the window relative to the
document's virtual line count. This mode works slower than `simple`
mode.
`proper` The scrollbar position and height are calculated similarly as for
`virtual` mode, but wrapped lines are considered in addition to
folds. On `nvim>=0.10`, diff filler and virtual text lines are also
considered. This mode works slower than `virtual` mode.
`auto` Under `auto` mode, the effective mode is set to `proper` when there are
relatively few buffer lines and luajit is available; `virtual` mode
is used otherwise.
Color Customization ~
*scrollview-color-customization*
The following highlight groups can be configured to change |nvim-scrollview|'s
colors.
`Name`
Default Target
---- ------
`ScrollView` scrollbar
Visual
`ScrollViewChangeListPrevious` changelist previous signs
SpecialKey
`ScrollViewChangeListCurrent` changelist current signs
SpecialKey
`ScrollViewChangeListNext` changelist next signs
SpecialKey
`ScrollViewConflictsTop` top conflict signs
DiffAdd
`ScrollViewConflictsMiddle` middle conflict signs
DiffAdd
`ScrollViewConflictsBottom` bottom conflict signs
DiffAdd
`ScrollViewCursor` cursor signs
Identifier
`ScrollViewDiagnosticsError` diagnostic error signs
The sign text highlight
for DiagnosticSignError
if defined, or DiagnosticError
otherwise
`ScrollViewDiagnosticsHint` diagnostic hint signs
The sign text highlight
for DiagnosticSignHint
if defined, or DiagnosticHint
otherwise
`ScrollViewDiagnosticsInfo` diagnostic info signs
The sign text highlight
for DiagnosticSignInfo
if defined, or DiagnosticInfo
otherwise
`ScrollViewDiagnosticsWarn` diagnostic warn signs
The sign text highlight
for DiagnosticSignWarn
if defined, or DiagnosticWarn
otherwise
`ScrollViewFolds` fold signs
Directory
`ScrollViewHover` scrollbar and signs on hover
CurSearch for nvim>=0.9.2
and WildMenu otherwise
`ScrollViewIndentSpaces` indent spaces signs
LineNr
`ScrollViewIndentTabs` indent spaces tabs
LineNr
`ScrollViewKeywordsFix` fix keyword signs
ColorColumn
`ScrollViewKeywordsHack` hack keyword signs
ColorColumn
`ScrollViewKeywordsTodo` todo keyword signs
ColorColumn
`ScrollViewKeywordsWarn` warn keyword signs
ColorColumn
`ScrollViewKeywordsXxx` xxx keyword signs
ColorColumn
`ScrollViewLatestChange` latestchange signs
SpecialKey
`ScrollViewLocList` loclist signs
LineNr
`ScrollViewMarks` mark signs
Identifier
`ScrollViewQuickFix` quickfix signs
Constant
`ScrollViewRestricted` |scrollview-restricted| scrollbar
CurSearch for nvim>=0.9.2
and MatchParen otherwise
`ScrollViewSearch` search signs
NonText
`ScrollViewSpell` spell signs
Statement
`ScrollViewTextWidth` textwidth signs
Question
The highlight groups can be customized in your |init.vim|, as shown in the
following example.
>
" Link ScrollView highlight to Pmenu highlight
highlight link ScrollView Pmenu
" Specify custom highlighting for ScrollView
highlight ScrollView ctermbg=159 guibg=LightCyan
============================================================================
5. Sign Extensibility *scrollview-signs-extensibility*
The plugin was written so that it's possible to extend the sign functionality
in a Neovim configuration file or with a plugin.
*scrollview-signs-version-global*
*scrollview_signs_version*
A global variable, `scrollview_signs_version`, has an integer representing the
version of the sign exensibility functionality. This can be accessed from Lua
(`vim.g.scrollview_signs_version`) or Vimscript (`g:scrollview_signs_version`).
Functions ~
deregister_sign_group({group}, {refresh}) *scrollview.deregister_sign_group()*
Deregister a sign group.
Parameters: ~
* {group} (string) Group name.
* {refresh} (boolean|nil) Optional argument specifying whether
scrollview refreshes afterwards. Defaults to `true`.
*scrollview.deregister_sign_spec()*
deregister_sign_spec({spec_id}, {refresh})
Deregister a sign specification.
Parameters: ~
* {spec_id} (integer) Specification identifier.
* {refresh} (boolean|nil) Optional argument specifying whether
scrollview refreshes afterwards. Defaults to `true`.
*scrollview-signs-functions*
Lua code is necessary for adding new sign functionality to `nvim-scrollview`.
>
local scrollview = require('scrollview')
get_sign_eligible_windows() *scrollview.get_sign_eligible_windows()*
Returns |window-ID|s that are eligible for signs to be shown.
Return: ~
(list) a list-like table with |window-ID|s.
is_sign_group_active({group}) *scrollview.is_sign_group_active()*
Checks whether a sign group is active. A group is considered active if
`nvim-scrollview` is enabled and the sign group is enabled.
Parameters: ~
* {group} (string) Group name.