-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsqroller.txt
89 lines (65 loc) · 2.71 KB
/
sqroller.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
*sqroller.txt* Adds scrollbar.
Author : Bakudankun
License: MIT
==============================================================================
CONTENTS *sqroller-contents*
INTRODUCTION |sqroller|
COMMANDS |sqroller-commands|
OPTIONS |sqroller-options|
==============================================================================
INTRODUCTION *sqroller*
sqroller.vim adds scrollbars to the leftmost column of each window. To achieve
this, sqroller.vim enables 'foldcolumn' and creates popup windows that overlap
them. Basic mouse interaction is supported.
==============================================================================
COMMANDS *sqroller-commands*
:SqrollerEnable *:SqrollerEnable*
Globally enables scrollbars.
:SqrollerDisable *:SqrollerDisable*
Globally disables scrollbars.
==============================================================================
OPTIONS *sqroller-options*
Every options are containd in *g:sqroller_config* dictionary.
*g:sqroller_config.algorithm*
algorithm (default: "keeplen")
Tweak how scrollbars are drawn.
"keeplen" Give weight to consistent length. Scrollbars
may sometimes shrink to the up while scrolling
down.
"topbot" Give weight to the accuracy of top/bottom
position of scrollbars. Scrollbars may
repeatedly shrink and extend while scrolling.
*g:sqroller_config.enabled*
enabled (default: true)
If |truthy|, scrollbars are globally enabled. You can toggle this with
`:SqrollerEnable` and `:SqrollerDisable` commands.
See |g:sqroller_config.hide_for| and |w:sqroller_enabled| to
individually show/hide scrollbars.
*g:sqroller_config.hide_for*
hide_for (default: [])
Specify the list of filetypes that scrollbars should be disabled.
*g:sqroller_config.hide_full_bars*
hide_full_bars (default: false)
If |truthy|, scrollbars are hidden when otherwise they have full
window height.
*g:sqroller_config.keepjumps*
keepjumps (default: false)
If |truthy|, clicking a scrollbar with mouse does not update the
|jumplist|.
*g:sqroller_config.style*
style (default: "heavy")
Specify the style of the scrollbar.
Possible values:
"light" Use light box drawing letters.
"heavy" Use heavy box drawing letters.
"block" Use block elements letters.
"left" Use left half block elements letters.
"right" Use right half block elements letters.
Note: This is a good option when 'ambiwidth'
is "double" because they are always single
width.
"ascii" Use only ASCII letters.
*w:sqroller_enabled*
You can enable/disable scrollbars for individual windows by setting
|window-variable| "w:sqroller_enabled" to true/false.
vim:tw=78:ts=8:noet:ft=help:norl: