@cloud-ru/ds-scroll 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/LICENSE +201 -0
- package/README.md +179 -0
- package/dist/cjs/Scroll.d.ts +107 -0
- package/dist/cjs/Scroll.js +124 -0
- package/dist/cjs/constants.d.ts +22 -0
- package/dist/cjs/constants.js +28 -0
- package/dist/cjs/index.d.ts +4 -0
- package/dist/cjs/index.js +13 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/style.css +290 -0
- package/dist/cjs/styles.module.css +290 -0
- package/dist/cjs/types.d.ts +6 -0
- package/dist/cjs/types.js +2 -0
- package/dist/esm/Scroll.d.ts +107 -0
- package/dist/esm/Scroll.js +118 -0
- package/dist/esm/constants.d.ts +22 -0
- package/dist/esm/constants.js +25 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +2 -0
- package/dist/esm/style.css +290 -0
- package/dist/esm/styles.module.css +290 -0
- package/dist/esm/types.d.ts +6 -0
- package/dist/esm/types.js +1 -0
- package/dist/tsconfig.cjs.tsbuildinfo +1 -0
- package/dist/tsconfig.esm.tsbuildinfo +1 -0
- package/package.json +45 -0
- package/src/Scroll.tsx +240 -0
- package/src/constants.ts +30 -0
- package/src/index.ts +11 -0
- package/src/styles.module.scss +163 -0
- package/src/types.ts +11 -0
package/CHANGELOG.md
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2023 Cloud technology Limited (Ltd.)
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Scroll
|
|
2
|
+
|
|
3
|
+
`@cloud-ru/ds-scroll` — Контейнер с кастомными скроллбарами, размерами s/m, стратегиями скрытия, автоскролом и опциональным ресайзом.
|
|
4
|
+
|
|
5
|
+
`Scroll` — контейнер с кастомными скроллбарами поверх [OverlayScrollbars](https://kingsora.github.io/OverlayScrollbars/). Оборачивает любой контент и подменяет нативные скроллбары на стилизованные — в двух размерах, с управляемыми стратегиями скрытия, автоскролом к краю и опциональным ресайзом.
|
|
6
|
+
|
|
7
|
+
## Когда использовать
|
|
8
|
+
- Прокручиваемые области внутри интерфейса: боковые панели, чаты, логи, списки, таблицы в карточках.
|
|
9
|
+
- Контент с динамической высотой, где нужно прилипание к низу (чат, live-лог) — через `autoscrollTo='bottom'`.
|
|
10
|
+
- Контейнер, размер которого пользователь регулирует сам — через `resize='both' | 'horizontal' | 'vertical'`.
|
|
11
|
+
|
|
12
|
+
Когда **не** использовать:
|
|
13
|
+
|
|
14
|
+
- На весь `<body>` — нативный скролл окна лучше для SEO, клавиатуры и системных жестов.
|
|
15
|
+
- Внутри виртуализированных списков — они уже управляют своим скроллом.
|
|
16
|
+
- Для коротких блоков, которые гарантированно помещаются — лишний контейнер и JS без выгоды.
|
|
17
|
+
|
|
18
|
+
## Анатомия
|
|
19
|
+
|
|
20
|
+
### Size
|
|
21
|
+
Толщина скролл-бара: `s` — дефолт для панелей и плотных списков; `m` — для крупных поверхностей, где нужен более заметный/удобный для мыши бар.
|
|
22
|
+
|
|
23
|
+
### Bar hide strategy
|
|
24
|
+
Когда скрывать скролл-бар: `never` — всегда видим; `leave` — скрыть при уводе курсора; `scroll` — видим только во время прокрутки; `move` — видим при движении курсора над областью.
|
|
25
|
+
|
|
26
|
+
### Resize
|
|
27
|
+
Разрешение пользовательского resize через CSS `resize`: `none` (дефолт), `horizontal`, `vertical`, `both`.
|
|
28
|
+
|
|
29
|
+
### Autoscroll to
|
|
30
|
+
Автоприлипание к краю при появлении нового контента: `bottom` — для чатов и лент; `right` — для горизонтальных лент.
|
|
31
|
+
|
|
32
|
+
## Установка
|
|
33
|
+
```bash
|
|
34
|
+
pnpm add @cloud-ru/ds-scroll
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import { Scroll } from '@cloud-ru/ds-scroll'
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Примеры использования
|
|
42
|
+
### Базовый скролл
|
|
43
|
+
|
|
44
|
+
Оборачивает любой контент; родитель задаёт высоту.
|
|
45
|
+
|
|
46
|
+
```tsx
|
|
47
|
+
import { Scroll } from '@cloud-ru/ds-scroll';
|
|
48
|
+
|
|
49
|
+
export function Basic() {
|
|
50
|
+
return (
|
|
51
|
+
<div style={{ height: 200, width: 320 }}>
|
|
52
|
+
<Scroll>
|
|
53
|
+
<div style={{ padding: 8 }}>
|
|
54
|
+
{Array.from({ length: 20 }, (_, i) => (
|
|
55
|
+
<div key={i}>Строка контента {i + 1}</div>
|
|
56
|
+
))}
|
|
57
|
+
</div>
|
|
58
|
+
</Scroll>
|
|
59
|
+
</div>
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Компактный размер s
|
|
65
|
+
|
|
66
|
+
Для узких областей и popover-ов.
|
|
67
|
+
|
|
68
|
+
```tsx
|
|
69
|
+
import { Scroll } from '@cloud-ru/ds-scroll';
|
|
70
|
+
|
|
71
|
+
export function SmallSize() {
|
|
72
|
+
return (
|
|
73
|
+
<div style={{ height: 180, width: 280 }}>
|
|
74
|
+
<Scroll size='s'>
|
|
75
|
+
<div style={{ padding: 8 }}>
|
|
76
|
+
{Array.from({ length: 15 }, (_, i) => (
|
|
77
|
+
<div key={i}>Пункт {i + 1}</div>
|
|
78
|
+
))}
|
|
79
|
+
</div>
|
|
80
|
+
</Scroll>
|
|
81
|
+
</div>
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Скроллбар появляется при наведении
|
|
87
|
+
|
|
88
|
+
`barHideStrategy="leave"` — спокойный, не отвлекающий UI.
|
|
89
|
+
|
|
90
|
+
```tsx
|
|
91
|
+
import { Scroll } from '@cloud-ru/ds-scroll';
|
|
92
|
+
|
|
93
|
+
export function HideOnLeave() {
|
|
94
|
+
return (
|
|
95
|
+
<div style={{ height: 200, width: 320 }}>
|
|
96
|
+
<Scroll barHideStrategy='leave'>
|
|
97
|
+
<div style={{ padding: 8 }}>
|
|
98
|
+
{Array.from({ length: 20 }, (_, i) => (
|
|
99
|
+
<div key={i}>Строка {i + 1}</div>
|
|
100
|
+
))}
|
|
101
|
+
</div>
|
|
102
|
+
</Scroll>
|
|
103
|
+
</div>
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Ресайзируемый контейнер
|
|
109
|
+
|
|
110
|
+
`resize="both"` — пользователь тянет за угол.
|
|
111
|
+
|
|
112
|
+
```tsx
|
|
113
|
+
import { Scroll } from '@cloud-ru/ds-scroll';
|
|
114
|
+
|
|
115
|
+
export function Resizable() {
|
|
116
|
+
return (
|
|
117
|
+
<div style={{ height: 200, width: 320 }}>
|
|
118
|
+
<Scroll resize='both'>
|
|
119
|
+
<div style={{ padding: 8 }}>
|
|
120
|
+
{Array.from({ length: 20 }, (_, i) => (
|
|
121
|
+
<div key={i}>Контент, который можно ресайзить — {i + 1}</div>
|
|
122
|
+
))}
|
|
123
|
+
</div>
|
|
124
|
+
</Scroll>
|
|
125
|
+
</div>
|
|
126
|
+
);
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Автоскрол вниз
|
|
131
|
+
|
|
132
|
+
Для чатов и live-логов — прилипание к низу при добавлении сообщений.
|
|
133
|
+
|
|
134
|
+
```tsx
|
|
135
|
+
import { Scroll } from '@cloud-ru/ds-scroll';
|
|
136
|
+
|
|
137
|
+
export function AutoscrollBottom() {
|
|
138
|
+
return (
|
|
139
|
+
<div style={{ height: 200, width: 320 }}>
|
|
140
|
+
<Scroll autoscrollTo='bottom'>
|
|
141
|
+
<div style={{ padding: 8 }}>
|
|
142
|
+
{Array.from({ length: 40 }, (_, i) => (
|
|
143
|
+
<div key={i}>Сообщение {i + 1}</div>
|
|
144
|
+
))}
|
|
145
|
+
</div>
|
|
146
|
+
</Scroll>
|
|
147
|
+
</div>
|
|
148
|
+
);
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Props
|
|
153
|
+
**ScrollProps**
|
|
154
|
+
|
|
155
|
+
| Prop | Type | Default | Description |
|
|
156
|
+
|------|------|---------|-------------|
|
|
157
|
+
| `autoscrollTo` | `"bottom"` \| `"right"` | — | Включает автоскрол при маунте и изменении размера контента: <br/> <br /> - `bottom` - автоскрол вниз, <br/> <br /> - `right` - автоскрол вправо, |
|
|
158
|
+
| `barHideStrategy` | `"leave"` \| `"move"` \| `"never"` \| `"scroll"` | `leave` | Управление скрытием скролл баров: <br/> <br /> - `Never` - показывать всегда <br/> <br /> - `Leave` - скрывать когда курсор покидает компонент <br/> <br /> - `Scroll` - показывать только когда происходит скроллинг <br/> <br /> - `Move` - показывать при движении курсора над компонентом |
|
|
159
|
+
| `children` | `string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| null \| undefined` | — | |
|
|
160
|
+
| `className` | `string` | — | |
|
|
161
|
+
| `clickScrolling` | `boolean` | `true` | Скролить ли по клику в скроллбар. |
|
|
162
|
+
| `data-test-id` | `string` | — | |
|
|
163
|
+
| `onInitialized` | `(() => void)` | — | Коллбэк вызывающийся на инициализацию скролла |
|
|
164
|
+
| `onScroll` | `((event?: Event) => void)` | — | Колбек события скрола. |
|
|
165
|
+
| `overflow` | `{ x?: "hidden" \| "scroll" \| "visible" \| "visible-hidden" \| "visible-scroll"; y?: "hidden" \| "scroll" \| "visible" \| "visible-hidden" \| "visible-scroll"; } \| undefined` | — | Поведение overflow по осям. По умолчанию OverlayScrollbars выставляет `scroll` <br/> на обе оси; если контента по оси быть не должно — передавай `'hidden'`. |
|
|
166
|
+
| `paddingAbsolute` | `boolean` | — | Должны ли паддинги быть абсолютными |
|
|
167
|
+
| `resize` | `"both"` \| `"horizontal"` \| `"none"` \| `"vertical"` | `none` | Настройка возможности регулировать Scroll-контейнер: <br/> <br /> - `None` - нельзя изменять размер <br/> <br /> - `Horizontal` - можно изменять размер только по горизонтали <br/> <br /> - `Vertical` - можно изменять размер только по вертикали <br/> <br /> - `Both` - можно изменять размер в обеих координатах |
|
|
168
|
+
| `size` | `"m"` \| `"s"` | `m` | Размер скролбаров |
|
|
169
|
+
| `untouchableScrollbars` | `boolean` | `false` | Отключает возможность взаимодействовать со скролбарами мышью. |
|
|
170
|
+
|
|
171
|
+
#### Related types
|
|
172
|
+
|
|
173
|
+
- `AutoscrollTo` = `"bottom"` \| `"right"`
|
|
174
|
+
|
|
175
|
+
- `BarHideStrategy` = `"leave"` \| `"move"` \| `"never"` \| `"scroll"`
|
|
176
|
+
|
|
177
|
+
- `Resize` = `"both"` \| `"horizontal"` \| `"none"` \| `"vertical"`
|
|
178
|
+
|
|
179
|
+
- `Size` = `"m"` \| `"s"`
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import 'overlayscrollbars/styles/overlayscrollbars.css';
|
|
2
|
+
import { WithSupportProps } from '@cloud-ru/ds-utils';
|
|
3
|
+
import { PropsWithChildren } from 'react';
|
|
4
|
+
import { AutoscrollTo, BarHideStrategy, Resize, Size } from './types';
|
|
5
|
+
export type ScrollProps = WithSupportProps<PropsWithChildren<{
|
|
6
|
+
className?: string;
|
|
7
|
+
/** Размер скролбаров */
|
|
8
|
+
size?: Size;
|
|
9
|
+
/** Скролить ли по клику в скроллбар. */
|
|
10
|
+
clickScrolling?: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* Включает автоскрол при маунте и изменении размера контента:
|
|
13
|
+
* <br /> - `bottom` - автоскрол вниз,
|
|
14
|
+
* <br /> - `right` - автоскрол вправо,
|
|
15
|
+
*/
|
|
16
|
+
autoscrollTo?: AutoscrollTo;
|
|
17
|
+
/**
|
|
18
|
+
* Управление скрытием скролл баров:
|
|
19
|
+
* <br /> - `Never` - показывать всегда
|
|
20
|
+
* <br /> - `Leave` - скрывать когда курсор покидает компонент
|
|
21
|
+
* <br /> - `Scroll` - показывать только когда происходит скроллинг
|
|
22
|
+
* <br /> - `Move` - показывать при движении курсора над компонентом
|
|
23
|
+
*/
|
|
24
|
+
barHideStrategy?: BarHideStrategy;
|
|
25
|
+
/** Колбек события скрола. */
|
|
26
|
+
onScroll?: (event?: Event) => void;
|
|
27
|
+
/**
|
|
28
|
+
* Настройка возможности регулировать Scroll-контейнер:
|
|
29
|
+
* <br /> - `None` - нельзя изменять размер
|
|
30
|
+
* <br /> - `Horizontal` - можно изменять размер только по горизонтали
|
|
31
|
+
* <br /> - `Vertical` - можно изменять размер только по вертикали
|
|
32
|
+
* <br /> - `Both` - можно изменять размер в обеих координатах
|
|
33
|
+
*/
|
|
34
|
+
resize?: Resize;
|
|
35
|
+
/** Отключает возможность взаимодействовать со скролбарами мышью. */
|
|
36
|
+
untouchableScrollbars?: boolean;
|
|
37
|
+
/** Должны ли паддинги быть абсолютными */
|
|
38
|
+
paddingAbsolute?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Поведение overflow по осям. По умолчанию OverlayScrollbars выставляет `scroll`
|
|
41
|
+
* на обе оси; если контента по оси быть не должно — передавай `'hidden'`.
|
|
42
|
+
*/
|
|
43
|
+
overflow?: {
|
|
44
|
+
x?: 'hidden' | 'visible' | 'scroll' | 'visible-hidden' | 'visible-scroll';
|
|
45
|
+
y?: 'hidden' | 'visible' | 'scroll' | 'visible-hidden' | 'visible-scroll';
|
|
46
|
+
};
|
|
47
|
+
/** Коллбэк вызывающийся на инициализацию скролла */
|
|
48
|
+
onInitialized?(): void;
|
|
49
|
+
}>>;
|
|
50
|
+
/**
|
|
51
|
+
* Установить nonce атрибут для инлайн стилей.
|
|
52
|
+
* @function setNonce
|
|
53
|
+
*/
|
|
54
|
+
export declare const setNonce: (newNonce: string | undefined) => void;
|
|
55
|
+
/**
|
|
56
|
+
* Scroll — контейнер с кастомными скроллбарами (OverlayScrollbars).
|
|
57
|
+
* Стили из @cloud-ru/ds-figma-variables (anatomy container + slider + theme colors).
|
|
58
|
+
*/
|
|
59
|
+
export declare const Scroll: import("react").ForwardRefExoticComponent<{
|
|
60
|
+
'data-test-id'?: string;
|
|
61
|
+
} & import("react").AriaAttributes & {
|
|
62
|
+
className?: string;
|
|
63
|
+
/** Размер скролбаров */
|
|
64
|
+
size?: Size;
|
|
65
|
+
/** Скролить ли по клику в скроллбар. */
|
|
66
|
+
clickScrolling?: boolean;
|
|
67
|
+
/**
|
|
68
|
+
* Включает автоскрол при маунте и изменении размера контента:
|
|
69
|
+
* <br /> - `bottom` - автоскрол вниз,
|
|
70
|
+
* <br /> - `right` - автоскрол вправо,
|
|
71
|
+
*/
|
|
72
|
+
autoscrollTo?: AutoscrollTo;
|
|
73
|
+
/**
|
|
74
|
+
* Управление скрытием скролл баров:
|
|
75
|
+
* <br /> - `Never` - показывать всегда
|
|
76
|
+
* <br /> - `Leave` - скрывать когда курсор покидает компонент
|
|
77
|
+
* <br /> - `Scroll` - показывать только когда происходит скроллинг
|
|
78
|
+
* <br /> - `Move` - показывать при движении курсора над компонентом
|
|
79
|
+
*/
|
|
80
|
+
barHideStrategy?: BarHideStrategy;
|
|
81
|
+
/** Колбек события скрола. */
|
|
82
|
+
onScroll?: (event?: Event) => void;
|
|
83
|
+
/**
|
|
84
|
+
* Настройка возможности регулировать Scroll-контейнер:
|
|
85
|
+
* <br /> - `None` - нельзя изменять размер
|
|
86
|
+
* <br /> - `Horizontal` - можно изменять размер только по горизонтали
|
|
87
|
+
* <br /> - `Vertical` - можно изменять размер только по вертикали
|
|
88
|
+
* <br /> - `Both` - можно изменять размер в обеих координатах
|
|
89
|
+
*/
|
|
90
|
+
resize?: Resize;
|
|
91
|
+
/** Отключает возможность взаимодействовать со скролбарами мышью. */
|
|
92
|
+
untouchableScrollbars?: boolean;
|
|
93
|
+
/** Должны ли паддинги быть абсолютными */
|
|
94
|
+
paddingAbsolute?: boolean;
|
|
95
|
+
/**
|
|
96
|
+
* Поведение overflow по осям. По умолчанию OverlayScrollbars выставляет `scroll`
|
|
97
|
+
* на обе оси; если контента по оси быть не должно — передавай `'hidden'`.
|
|
98
|
+
*/
|
|
99
|
+
overflow?: {
|
|
100
|
+
x?: "hidden" | "visible" | "scroll" | "visible-hidden" | "visible-scroll";
|
|
101
|
+
y?: "hidden" | "visible" | "scroll" | "visible-hidden" | "visible-scroll";
|
|
102
|
+
};
|
|
103
|
+
/** Коллбэк вызывающийся на инициализацию скролла */
|
|
104
|
+
onInitialized?(): void;
|
|
105
|
+
} & {
|
|
106
|
+
children?: import("react").ReactNode | undefined;
|
|
107
|
+
} & import("react").RefAttributes<HTMLElement>>;
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Scroll = exports.setNonce = void 0;
|
|
7
|
+
const jsx_runtime_1 = require("react/jsx-runtime");
|
|
8
|
+
require("overlayscrollbars/styles/overlayscrollbars.css");
|
|
9
|
+
const utils_1 = require("@cloud-ru/ds-utils");
|
|
10
|
+
const classnames_1 = __importDefault(require("classnames"));
|
|
11
|
+
const overlayscrollbars_1 = require("overlayscrollbars");
|
|
12
|
+
const overlayscrollbars_react_1 = require("overlayscrollbars-react");
|
|
13
|
+
const react_1 = require("react");
|
|
14
|
+
const constants_1 = require("./constants");
|
|
15
|
+
const styles_module_scss_1 = __importDefault(require('./styles.module.css'));
|
|
16
|
+
/**
|
|
17
|
+
* Установить nonce атрибут для инлайн стилей.
|
|
18
|
+
* @function setNonce
|
|
19
|
+
*/
|
|
20
|
+
exports.setNonce = overlayscrollbars_1.OverlayScrollbars.nonce;
|
|
21
|
+
/**
|
|
22
|
+
* Scroll — контейнер с кастомными скроллбарами (OverlayScrollbars).
|
|
23
|
+
* Стили из @cloud-ru/ds-figma-variables (anatomy container + slider + theme colors).
|
|
24
|
+
*/
|
|
25
|
+
exports.Scroll = (0, react_1.forwardRef)(function Scroll({ children, className, onScroll: onScrollProp, onInitialized: onInitializedProp, size = constants_1.SIZE.M, resize = constants_1.RESIZE.None, clickScrolling = true, barHideStrategy = constants_1.BAR_HIDE_STRATEGY.Leave, autoscrollTo, paddingAbsolute, overflow, untouchableScrollbars = false, ...rest }, ref) {
|
|
26
|
+
const overlayScrollbarsRef = (0, react_1.useRef)(null);
|
|
27
|
+
const [isOverlayScrollbarInited, setOverlayScrollbarInited] = (0, react_1.useState)(false);
|
|
28
|
+
const getOSInstance = (0, react_1.useCallback)((overlayScrollbars = overlayScrollbarsRef.current) => overlayScrollbars?.osInstance(), [overlayScrollbarsRef]);
|
|
29
|
+
(0, react_1.useImperativeHandle)(ref, () => (overlayScrollbarsRef.current?.osInstance()?.elements().viewport ?? null));
|
|
30
|
+
const lastPositionsRef = (0, react_1.useRef)({ scrolledToBottom: false, scrolledToRight: false });
|
|
31
|
+
const syncPositions = (0, react_1.useCallback)((scrollbars) => {
|
|
32
|
+
const instance = getOSInstance(scrollbars);
|
|
33
|
+
if (instance) {
|
|
34
|
+
const { viewport } = instance.elements();
|
|
35
|
+
const gapToBottom = viewport.scrollHeight - (viewport.offsetHeight + viewport.scrollTop);
|
|
36
|
+
const gapToRight = viewport.scrollWidth - (viewport.offsetWidth + viewport.scrollLeft);
|
|
37
|
+
const hasYScroll = viewport.scrollHeight > viewport.offsetHeight;
|
|
38
|
+
const hasXScroll = viewport.scrollWidth > viewport.offsetWidth;
|
|
39
|
+
lastPositionsRef.current.scrolledToBottom = gapToBottom < constants_1.AUTOSCROLL_ENABLE_LIMIT || !hasYScroll;
|
|
40
|
+
lastPositionsRef.current.scrolledToRight = gapToRight < constants_1.AUTOSCROLL_ENABLE_LIMIT || !hasXScroll;
|
|
41
|
+
}
|
|
42
|
+
}, [getOSInstance]);
|
|
43
|
+
(0, utils_1.useLayoutEffect)(() => {
|
|
44
|
+
if (!autoscrollTo) {
|
|
45
|
+
onInitializedProp?.();
|
|
46
|
+
return;
|
|
47
|
+
}
|
|
48
|
+
const instance = getOSInstance();
|
|
49
|
+
if (instance && isOverlayScrollbarInited) {
|
|
50
|
+
syncPositions();
|
|
51
|
+
const { content } = instance.elements();
|
|
52
|
+
autoscrollTo === constants_1.AUTOSCROLL_TO.Bottom && content.scroll(0, content.scrollHeight);
|
|
53
|
+
autoscrollTo === constants_1.AUTOSCROLL_TO.Right && content.scroll(content.scrollWidth, 0);
|
|
54
|
+
}
|
|
55
|
+
onInitializedProp?.();
|
|
56
|
+
/* autoscrollTo умышленно не в депсах — интересен только на момент маунта */
|
|
57
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
58
|
+
}, [getOSInstance, isOverlayScrollbarInited, syncPositions]);
|
|
59
|
+
const injectStateLayers = (0, react_1.useCallback)(() => {
|
|
60
|
+
const instance = overlayScrollbarsRef.current?.osInstance();
|
|
61
|
+
const host = instance?.elements().host;
|
|
62
|
+
if (!host) {
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
host.querySelectorAll('.os-scrollbar-handle').forEach((handle) => {
|
|
66
|
+
const stateLayerClass = styles_module_scss_1.default.stateLayer ?? '';
|
|
67
|
+
if (!stateLayerClass)
|
|
68
|
+
return;
|
|
69
|
+
if (handle.querySelector(`.${CSS.escape(stateLayerClass)}`)) {
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
if ((0, utils_1.isBrowser)()) {
|
|
73
|
+
const layer = document.createElement('div');
|
|
74
|
+
layer.classList.add(stateLayerClass);
|
|
75
|
+
layer.setAttribute('data-state', 'versionOnColor');
|
|
76
|
+
handle.appendChild(layer);
|
|
77
|
+
}
|
|
78
|
+
});
|
|
79
|
+
}, []);
|
|
80
|
+
const onInitialized = (0, react_1.useCallback)(() => {
|
|
81
|
+
injectStateLayers();
|
|
82
|
+
setOverlayScrollbarInited(true);
|
|
83
|
+
}, [injectStateLayers]);
|
|
84
|
+
const onScroll = (0, react_1.useCallback)((event) => {
|
|
85
|
+
onScrollProp?.(event);
|
|
86
|
+
if (autoscrollTo) {
|
|
87
|
+
syncPositions();
|
|
88
|
+
}
|
|
89
|
+
},
|
|
90
|
+
/* autoscrollTo не аффектит на расчеты в syncPositions */
|
|
91
|
+
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
92
|
+
[onScrollProp, syncPositions]);
|
|
93
|
+
const onContentSizeChanged = (0, react_1.useCallback)(() => {
|
|
94
|
+
if (!autoscrollTo)
|
|
95
|
+
return;
|
|
96
|
+
const instance = getOSInstance()?.elements();
|
|
97
|
+
if (instance?.content) {
|
|
98
|
+
if (lastPositionsRef.current.scrolledToBottom && autoscrollTo === constants_1.AUTOSCROLL_TO.Bottom) {
|
|
99
|
+
instance?.content.scroll(0, instance?.content.scrollHeight);
|
|
100
|
+
}
|
|
101
|
+
if (lastPositionsRef.current.scrolledToRight && autoscrollTo === constants_1.AUTOSCROLL_TO.Right) {
|
|
102
|
+
instance?.content.scroll(instance?.content.scrollWidth, 0);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
}, [getOSInstance, autoscrollTo]);
|
|
106
|
+
return ((0, jsx_runtime_1.jsx)(overlayscrollbars_react_1.OverlayScrollbarsComponent, { ...rest, ref: overlayScrollbarsRef, "data-size": size, "data-untouchable-scrollbars": untouchableScrollbars || undefined, className: (0, classnames_1.default)(className, styles_module_scss_1.default.scroll, 'osThemeSnack'), style: { resize }, options: {
|
|
107
|
+
paddingAbsolute,
|
|
108
|
+
overflow,
|
|
109
|
+
scrollbars: {
|
|
110
|
+
autoHide: barHideStrategy,
|
|
111
|
+
autoHideDelay: constants_1.BAR_AUTO_HIDE_DELAY_MS,
|
|
112
|
+
clickScroll: clickScrolling,
|
|
113
|
+
},
|
|
114
|
+
}, events: {
|
|
115
|
+
initialized: onInitialized,
|
|
116
|
+
scroll: (_instance, event) => {
|
|
117
|
+
onScroll(event);
|
|
118
|
+
},
|
|
119
|
+
updated: () => {
|
|
120
|
+
injectStateLayers();
|
|
121
|
+
onContentSizeChanged();
|
|
122
|
+
},
|
|
123
|
+
}, children: autoscrollTo ? isOverlayScrollbarInited && children : children }));
|
|
124
|
+
});
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export declare const SIZE: {
|
|
2
|
+
readonly S: "s";
|
|
3
|
+
readonly M: "m";
|
|
4
|
+
};
|
|
5
|
+
export declare const BAR_HIDE_STRATEGY: {
|
|
6
|
+
readonly Never: "never";
|
|
7
|
+
readonly Leave: "leave";
|
|
8
|
+
readonly Scroll: "scroll";
|
|
9
|
+
readonly Move: "move";
|
|
10
|
+
};
|
|
11
|
+
export declare const RESIZE: {
|
|
12
|
+
readonly None: "none";
|
|
13
|
+
readonly Horizontal: "horizontal";
|
|
14
|
+
readonly Vertical: "vertical";
|
|
15
|
+
readonly Both: "both";
|
|
16
|
+
};
|
|
17
|
+
export declare const AUTOSCROLL_TO: {
|
|
18
|
+
readonly Bottom: "bottom";
|
|
19
|
+
readonly Right: "right";
|
|
20
|
+
};
|
|
21
|
+
export declare const BAR_AUTO_HIDE_DELAY_MS = 100;
|
|
22
|
+
export declare const AUTOSCROLL_ENABLE_LIMIT = 2;
|