overlayscrollbars-react 0.2.1 → 0.3.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/LICENSE +20 -20
- package/README.md +123 -102
- package/dist/overlayscrollbars-react.esm.js +16 -2
- package/dist/overlayscrollbars-react.esm.js.map +1 -1
- package/dist/overlayscrollbars-react.js +19 -5
- package/dist/overlayscrollbars-react.js.map +1 -1
- package/package.json +51 -52
- package/src/OverlayScrollbarsComponent.tsx +94 -77
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2019 Rene Haas
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 Rene Haas
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
21
|
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,102 +1,123 @@
|
|
|
1
|
-
<p align="center">
|
|
2
|
-
<a href="https://reactjs.org/"><img src="https://kingsora.github.io/OverlayScrollbars/frameworks/react/logo.svg" width="200" height="133" alt="React"></a>
|
|
3
|
-
<a href="https://kingsora.github.io/OverlayScrollbars/"><img src="https://kingsora.github.io/OverlayScrollbars/design/logo.svg" width="200" height="133" alt="OverlayScrollbars"></a>
|
|
4
|
-
</p>
|
|
5
|
-
<h6 align="center">
|
|
6
|
-
<a href="https://github.com/facebook/react/"><img src="https://img.shields.io/badge/React-%
|
|
7
|
-
<a href="https://github.com/KingSora/OverlayScrollbars"><img src="https://img.shields.io/badge/OverlayScrollbars-%5E1.10.0-36befd?style=flat-square" alt="OverlayScrollbars"></a>
|
|
8
|
-
<a href="https://www.npmjs.com/package/overlayscrollbars-react"><img src="https://img.shields.io/npm/dt/overlayscrollbars-react.svg?style=flat-square" alt="Downloads"></a>
|
|
9
|
-
<a href="https://github.com/KingSora/OverlayScrollbars/blob/master/packages/overlayscrollbars-react/LICENSE"><img src="https://img.shields.io/github/license/kingsora/overlayscrollbars.svg?style=flat-square" alt="License"></a>
|
|
10
|
-
</h6>
|
|
11
|
-
<h3 align="center">
|
|
12
|
-
<a href="https://kingsora.github.io/OverlayScrollbars/frameworks/react/">Example</a>
|
|
13
|
-
•
|
|
14
|
-
<a href="https://kingsora.github.io/OverlayScrollbars/#!documentation">Documentation</a>
|
|
15
|
-
•
|
|
16
|
-
<a href="https://kingsora.github.io/OverlayScrollbars/#!faq">FAQ</a>
|
|
17
|
-
</h3>
|
|
18
|
-
<h5 align="center">
|
|
19
|
-
The official OverlayScrollbars wrapper for React.
|
|
20
|
-
</h5>
|
|
21
|
-
|
|
22
|
-
## Installation
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
npm install
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
npm install
|
|
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
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://reactjs.org/"><img src="https://kingsora.github.io/OverlayScrollbars/frameworks/react/logo.svg" width="200" height="133" alt="React"></a>
|
|
3
|
+
<a href="https://kingsora.github.io/OverlayScrollbars/"><img src="https://kingsora.github.io/OverlayScrollbars/design/logo.svg" width="200" height="133" alt="OverlayScrollbars"></a>
|
|
4
|
+
</p>
|
|
5
|
+
<h6 align="center">
|
|
6
|
+
<a href="https://github.com/facebook/react/"><img src="https://img.shields.io/badge/React-%3E=16.4.0-61dafb?style=flat-square&logo=React" alt="React"></a>
|
|
7
|
+
<a href="https://github.com/KingSora/OverlayScrollbars"><img src="https://img.shields.io/badge/OverlayScrollbars-%5E1.10.0-36befd?style=flat-square" alt="OverlayScrollbars"></a>
|
|
8
|
+
<a href="https://www.npmjs.com/package/overlayscrollbars-react"><img src="https://img.shields.io/npm/dt/overlayscrollbars-react.svg?style=flat-square" alt="Downloads"></a>
|
|
9
|
+
<a href="https://github.com/KingSora/OverlayScrollbars/blob/master/packages/overlayscrollbars-react/LICENSE"><img src="https://img.shields.io/github/license/kingsora/overlayscrollbars.svg?style=flat-square" alt="License"></a>
|
|
10
|
+
</h6>
|
|
11
|
+
<h3 align="center">
|
|
12
|
+
<a href="https://kingsora.github.io/OverlayScrollbars/frameworks/react/">Example</a>
|
|
13
|
+
•
|
|
14
|
+
<a href="https://kingsora.github.io/OverlayScrollbars/#!documentation">Documentation</a>
|
|
15
|
+
•
|
|
16
|
+
<a href="https://kingsora.github.io/OverlayScrollbars/#!faq">FAQ</a>
|
|
17
|
+
</h3>
|
|
18
|
+
<h5 align="center">
|
|
19
|
+
The official OverlayScrollbars wrapper for React.
|
|
20
|
+
</h5>
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
npm install overlayscrollbars-react
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Peer Dependencies
|
|
29
|
+
|
|
30
|
+
OverlayScrollbars for React has the following **peer dependencies**:
|
|
31
|
+
|
|
32
|
+
- The vanilla JavaScript library: [overlayscrollbars](https://www.npmjs.com/package/overlayscrollbars)
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
npm install overlayscrollbars
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
- The React framework: [react](https://www.npmjs.com/package/react)
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
npm install react
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## TypeScript
|
|
45
|
+
|
|
46
|
+
- In case you are using TypeScript, you have to install the [OverlayScrollbars typings](https://www.npmjs.com/package/@types/overlayscrollbars):
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
npm install @types/overlayscrollbars
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Since this wrapper is written in TypeScript it comes with its generated typings.<br>
|
|
53
|
+
Check out the [recommended](https://github.com/KingSora/OverlayScrollbars#typescript) **tsconfig.json** options.
|
|
54
|
+
|
|
55
|
+
## Usage
|
|
56
|
+
|
|
57
|
+
#### CSS
|
|
58
|
+
|
|
59
|
+
You have to import the `OverlayScrollbars.css` by yourself.<br>
|
|
60
|
+
The component **doesn't** do it for you as the styles are **global styles**!<br>
|
|
61
|
+
There are different ways to achieve this, in React the most simple way for me was to add [this line](https://github.com/KingSora/OverlayScrollbars/blob/master/packages/overlayscrollbars-react/example/src/index.tsx#L1) in the `index` file:
|
|
62
|
+
|
|
63
|
+
```js
|
|
64
|
+
import "overlayscrollbars/css/OverlayScrollbars.css";
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
#### Import
|
|
68
|
+
|
|
69
|
+
Simply import the component into your file(s):
|
|
70
|
+
|
|
71
|
+
```js
|
|
72
|
+
import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
#### Template
|
|
76
|
+
|
|
77
|
+
After the import you can use it in JSX:
|
|
78
|
+
|
|
79
|
+
```jsx
|
|
80
|
+
<OverlayScrollbarsComponent>example content</OverlayScrollbarsComponent>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
#### Properties
|
|
84
|
+
|
|
85
|
+
Two properties are accepted: `options` and `extensions`.
|
|
86
|
+
|
|
87
|
+
- The `options` property accepts a `object` and can be changed at any point in time, and the plugin will adapt.
|
|
88
|
+
- The `extensions` property accepts a `string`, `string array` or `object` and is only taken into account if the component gets mounted.
|
|
89
|
+
|
|
90
|
+
```jsx
|
|
91
|
+
<OverlayScrollbarsComponent
|
|
92
|
+
options={{ scrollbars: { autoHide: "scroll" } }}
|
|
93
|
+
extensions={["extensionA", "extensionB"]}
|
|
94
|
+
></OverlayScrollbarsComponent>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
You can read more about the `options` object [here](https://kingsora.github.io/OverlayScrollbars/#!documentation/options), `extensions` are documented [here](https://kingsora.github.io/OverlayScrollbars/#!documentation/extensions-basics) and [here](https://kingsora.github.io/OverlayScrollbars/#!documentation/initialization).
|
|
98
|
+
|
|
99
|
+
#### Instance
|
|
100
|
+
|
|
101
|
+
If you get the component reference, it provides two methods: `osInstance()` and `osTarget()`.
|
|
102
|
+
|
|
103
|
+
- The `osInstance()` method returns the OverlayScrollbars `instance` of the component, or `null` if the instance isn't initialized yet or already destroyed.
|
|
104
|
+
- The `osTarget()` method returns the native `html` element to which the plugin was initialized, or `null` if the the component isn't mounted yet or already unmounted.
|
|
105
|
+
|
|
106
|
+
## Example App
|
|
107
|
+
|
|
108
|
+
In case you need a example app for reference, you can use the example app in this repo(`example folder`):
|
|
109
|
+
|
|
110
|
+
- [Live example](https://kingsora.github.io/OverlayScrollbars/frameworks/react/)
|
|
111
|
+
- [Source code](https://github.com/KingSora/OverlayScrollbars/tree/master/packages/overlayscrollbars-react/example)
|
|
112
|
+
|
|
113
|
+
If you wanna build the example app, run these commands:
|
|
114
|
+
|
|
115
|
+
```sh
|
|
116
|
+
npm run setup
|
|
117
|
+
npm run build
|
|
118
|
+
npm run example
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## License
|
|
122
|
+
|
|
123
|
+
MIT
|
|
@@ -42,6 +42,7 @@ class OverlayScrollbarsComponent extends Component {
|
|
|
42
42
|
}
|
|
43
43
|
componentDidMount() {
|
|
44
44
|
this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);
|
|
45
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
45
46
|
}
|
|
46
47
|
componentWillUnmount() {
|
|
47
48
|
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
@@ -52,11 +53,14 @@ class OverlayScrollbarsComponent extends Component {
|
|
|
52
53
|
componentDidUpdate(prevProps) {
|
|
53
54
|
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
54
55
|
this._osInstance.options(this.props.options);
|
|
56
|
+
if (prevProps.className !== this.props.className) {
|
|
57
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
58
|
+
}
|
|
55
59
|
}
|
|
56
60
|
}
|
|
57
61
|
render() {
|
|
58
|
-
|
|
59
|
-
return (React.createElement("div", Object.assign({ className:
|
|
62
|
+
const _a = this.props, divProps = __rest(_a, ["options", "extensions", "children", "className"]);
|
|
63
|
+
return (React.createElement("div", Object.assign({ className: "os-host" }, divProps, { ref: this._osTargetRef }),
|
|
60
64
|
React.createElement("div", { className: "os-resize-observer-host" }),
|
|
61
65
|
React.createElement("div", { className: "os-padding" },
|
|
62
66
|
React.createElement("div", { className: "os-viewport" },
|
|
@@ -69,6 +73,16 @@ class OverlayScrollbarsComponent extends Component {
|
|
|
69
73
|
React.createElement("div", { className: "os-scrollbar-handle" }))),
|
|
70
74
|
React.createElement("div", { className: "os-scrollbar-corner" })));
|
|
71
75
|
}
|
|
76
|
+
}
|
|
77
|
+
function mergeHostClassNames(osInstance, className) {
|
|
78
|
+
if (OverlayScrollbars.valid(osInstance)) {
|
|
79
|
+
const { host } = osInstance.getElements();
|
|
80
|
+
const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\s/g, "$|")}$`, 'g');
|
|
81
|
+
const osClassNames = host.className.split(' ')
|
|
82
|
+
.filter(name => name.match(regex))
|
|
83
|
+
.join(' ');
|
|
84
|
+
host.className = `${osClassNames} ${className || ''}`;
|
|
85
|
+
}
|
|
72
86
|
}
|
|
73
87
|
|
|
74
88
|
export { OverlayScrollbarsComponent };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"overlayscrollbars-react.esm.js","sources":["../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import React, { Component, RefObject } from 'react';\r\nimport OverlayScrollbars from \"overlayscrollbars\";\r\n\r\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\r\n children?: any;\r\n options?: OverlayScrollbars.Options;\r\n extensions?: OverlayScrollbars.Extensions;\r\n}\r\nexport interface OverlayScrollbarsComponentState { }\r\n\r\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\r\n private _osInstance: OverlayScrollbars | null = null;\r\n private _osTargetRef: RefObject<HTMLDivElement>;\r\n\r\n constructor(props: OverlayScrollbarsComponentProps) {\r\n super(props);\r\n this._osTargetRef = React.createRef();\r\n }\r\n\r\n osInstance(): OverlayScrollbars | null {\r\n return this._osInstance;\r\n }\r\n\r\n osTarget(): HTMLDivElement | null {\r\n return this._osTargetRef.current || null;\r\n }\r\n\r\n componentDidMount() {\r\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\r\n }\r\n\r\n componentWillUnmount() {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.destroy();\r\n this._osInstance = null;\r\n }\r\n }\r\n\r\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.options(this.props.options);\r\n }\r\n }\r\n\r\n render() {\r\n
|
|
1
|
+
{"version":3,"file":"overlayscrollbars-react.esm.js","sources":["../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import React, { Component, RefObject } from 'react';\r\nimport OverlayScrollbars from \"overlayscrollbars\";\r\n\r\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\r\n children?: any;\r\n options?: OverlayScrollbars.Options;\r\n extensions?: OverlayScrollbars.Extensions;\r\n}\r\nexport interface OverlayScrollbarsComponentState { }\r\n\r\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\r\n private _osInstance: OverlayScrollbars | null = null;\r\n private _osTargetRef: RefObject<HTMLDivElement>;\r\n\r\n constructor(props: OverlayScrollbarsComponentProps) {\r\n super(props);\r\n this._osTargetRef = React.createRef();\r\n }\r\n\r\n osInstance(): OverlayScrollbars | null {\r\n return this._osInstance;\r\n }\r\n\r\n osTarget(): HTMLDivElement | null {\r\n return this._osTargetRef.current || null;\r\n }\r\n\r\n componentDidMount() {\r\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\r\n mergeHostClassNames(this._osInstance, this.props.className);\r\n }\r\n\r\n componentWillUnmount() {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.destroy();\r\n this._osInstance = null;\r\n }\r\n }\r\n\r\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.options(this.props.options);\r\n\r\n if (prevProps.className !== this.props.className) {\r\n mergeHostClassNames(this._osInstance, this.props.className);\r\n }\r\n }\r\n }\r\n\r\n render() {\r\n const {\r\n options,\r\n extensions,\r\n children,\r\n className,\r\n ...divProps\r\n } = this.props;\r\n\r\n return (\r\n <div className=\"os-host\" {...divProps} ref={this._osTargetRef}>\r\n <div className=\"os-resize-observer-host\"></div>\r\n <div className=\"os-padding\">\r\n <div className=\"os-viewport\">\r\n <div className=\"os-content\">\r\n {this.props.children}\r\n </div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar os-scrollbar-horizontal \">\r\n <div className=\"os-scrollbar-track\">\r\n <div className=\"os-scrollbar-handle\"></div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar os-scrollbar-vertical\">\r\n <div className=\"os-scrollbar-track\">\r\n <div className=\"os-scrollbar-handle\"></div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar-corner\"></div>\r\n </div>\r\n );\r\n }\r\n}\r\n\r\nfunction mergeHostClassNames(osInstance: OverlayScrollbars, className: string) {\r\n if (OverlayScrollbars.valid(osInstance)) {\r\n const { host } = osInstance.getElements();\r\n const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\\s/g, \"$|\")}$`, 'g');\r\n const osClassNames = host.className.split(' ')\r\n .filter(name => name.match(regex))\r\n .join(' ');\r\n\r\n host.className = `${osClassNames} ${className || ''}`;\r\n }\r\n}"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAUa,0BAA2B,SAAQ,SAA2E;IAIvH,YAAY,KAAsC;QAC9C,KAAK,CAAC,KAAK,CAAC,CAAC;QAJT,gBAAW,GAA6B,IAAI,CAAC;QAKjD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;KACzC;IAED,UAAU;QACN,OAAO,IAAI,CAAC,WAAW,CAAC;KAC3B;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC;KAC5C;IAED,iBAAiB;QACb,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvG,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;KAC/D;IAED,oBAAoB;QAChB,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC3C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;SAC3B;KACJ;IAED,kBAAkB,CAAC,SAA0C;QACzD,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC3C,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAE7C,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;gBAC9C,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;aAC/D;SACJ;KACJ;IAED,MAAM;cACI,eAMQ,EADV,0EACW;QAEf,QACI,2CAAK,SAAS,EAAC,SAAS,IAAK,QAAQ,IAAE,GAAG,EAAE,IAAI,CAAC,YAAY;YACzD,6BAAK,SAAS,EAAC,yBAAyB,GAAO;YAC/C,6BAAK,SAAS,EAAC,YAAY;gBACvB,6BAAK,SAAS,EAAC,aAAa;oBACxB,6BAAK,SAAS,EAAC,YAAY,IACtB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAClB,CACJ,CACJ;YACN,6BAAK,SAAS,EAAC,uCAAuC;gBAClD,6BAAK,SAAS,EAAC,oBAAoB;oBAC/B,6BAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,CACJ;YACN,6BAAK,SAAS,EAAC,oCAAoC;gBAC/C,6BAAK,SAAS,EAAC,oBAAoB;oBAC/B,6BAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,CACJ;YACN,6BAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,EACR;KACL;CACJ;AAED,SAAS,mBAAmB,CAAC,UAA6B,EAAE,SAAiB;IACzE,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,wBAAwB,UAAU,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC9G,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;aACzC,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACjC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEf,IAAI,CAAC,SAAS,GAAG,GAAG,YAAY,IAAI,SAAS,IAAI,EAAE,EAAE,CAAC;KACzD;AACL;;;;"}
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react'), require('overlayscrollbars')) :
|
|
3
3
|
typeof define === 'function' && define.amd ? define(['exports', 'react', 'overlayscrollbars'], factory) :
|
|
4
4
|
(global = global || self, factory(global.OverlayScrollbarsReact = {}, global.React, global.OverlayScrollbars));
|
|
5
|
-
}(this, function (exports, React, OverlayScrollbars) { 'use strict';
|
|
5
|
+
}(this, (function (exports, React, OverlayScrollbars) { 'use strict';
|
|
6
6
|
|
|
7
7
|
var React__default = 'default' in React ? React['default'] : React;
|
|
8
|
-
OverlayScrollbars = OverlayScrollbars &&
|
|
8
|
+
OverlayScrollbars = OverlayScrollbars && Object.prototype.hasOwnProperty.call(OverlayScrollbars, 'default') ? OverlayScrollbars['default'] : OverlayScrollbars;
|
|
9
9
|
|
|
10
10
|
/*! *****************************************************************************
|
|
11
11
|
Copyright (c) Microsoft Corporation. All rights reserved.
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
};
|
|
76
76
|
OverlayScrollbarsComponent.prototype.componentDidMount = function () {
|
|
77
77
|
this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);
|
|
78
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
78
79
|
};
|
|
79
80
|
OverlayScrollbarsComponent.prototype.componentWillUnmount = function () {
|
|
80
81
|
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
@@ -85,11 +86,14 @@
|
|
|
85
86
|
OverlayScrollbarsComponent.prototype.componentDidUpdate = function (prevProps) {
|
|
86
87
|
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
87
88
|
this._osInstance.options(this.props.options);
|
|
89
|
+
if (prevProps.className !== this.props.className) {
|
|
90
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
91
|
+
}
|
|
88
92
|
}
|
|
89
93
|
};
|
|
90
94
|
OverlayScrollbarsComponent.prototype.render = function () {
|
|
91
95
|
var _a = this.props, options = _a.options, extensions = _a.extensions, children = _a.children, className = _a.className, divProps = __rest(_a, ["options", "extensions", "children", "className"]);
|
|
92
|
-
return (React__default.createElement("div", __assign({ className:
|
|
96
|
+
return (React__default.createElement("div", __assign({ className: "os-host" }, divProps, { ref: this._osTargetRef }),
|
|
93
97
|
React__default.createElement("div", { className: "os-resize-observer-host" }),
|
|
94
98
|
React__default.createElement("div", { className: "os-padding" },
|
|
95
99
|
React__default.createElement("div", { className: "os-viewport" },
|
|
@@ -103,11 +107,21 @@
|
|
|
103
107
|
React__default.createElement("div", { className: "os-scrollbar-corner" })));
|
|
104
108
|
};
|
|
105
109
|
return OverlayScrollbarsComponent;
|
|
106
|
-
}(React.Component));
|
|
110
|
+
}(React.Component));
|
|
111
|
+
function mergeHostClassNames(osInstance, className) {
|
|
112
|
+
if (OverlayScrollbars.valid(osInstance)) {
|
|
113
|
+
var host = osInstance.getElements().host;
|
|
114
|
+
var regex_1 = new RegExp("(^os-host([-_].+|)$)|" + osInstance.options().className.replace(/\s/g, "$|") + "$", 'g');
|
|
115
|
+
var osClassNames = host.className.split(' ')
|
|
116
|
+
.filter(function (name) { return name.match(regex_1); })
|
|
117
|
+
.join(' ');
|
|
118
|
+
host.className = osClassNames + " " + (className || '');
|
|
119
|
+
}
|
|
120
|
+
}
|
|
107
121
|
|
|
108
122
|
exports.OverlayScrollbarsComponent = OverlayScrollbarsComponent;
|
|
109
123
|
|
|
110
124
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
111
125
|
|
|
112
|
-
}));
|
|
126
|
+
})));
|
|
113
127
|
//# sourceMappingURL=overlayscrollbars-react.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"overlayscrollbars-react.js","sources":["../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import React, { Component, RefObject } from 'react';\r\nimport OverlayScrollbars from \"overlayscrollbars\";\r\n\r\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\r\n children?: any;\r\n options?: OverlayScrollbars.Options;\r\n extensions?: OverlayScrollbars.Extensions;\r\n}\r\nexport interface OverlayScrollbarsComponentState { }\r\n\r\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\r\n private _osInstance: OverlayScrollbars | null = null;\r\n private _osTargetRef: RefObject<HTMLDivElement>;\r\n\r\n constructor(props: OverlayScrollbarsComponentProps) {\r\n super(props);\r\n this._osTargetRef = React.createRef();\r\n }\r\n\r\n osInstance(): OverlayScrollbars | null {\r\n return this._osInstance;\r\n }\r\n\r\n osTarget(): HTMLDivElement | null {\r\n return this._osTargetRef.current || null;\r\n }\r\n\r\n componentDidMount() {\r\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\r\n }\r\n\r\n componentWillUnmount() {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.destroy();\r\n this._osInstance = null;\r\n }\r\n }\r\n\r\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.options(this.props.options);\r\n }\r\n }\r\n\r\n render() {\r\n
|
|
1
|
+
{"version":3,"file":"overlayscrollbars-react.js","sources":["../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import React, { Component, RefObject } from 'react';\r\nimport OverlayScrollbars from \"overlayscrollbars\";\r\n\r\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\r\n children?: any;\r\n options?: OverlayScrollbars.Options;\r\n extensions?: OverlayScrollbars.Extensions;\r\n}\r\nexport interface OverlayScrollbarsComponentState { }\r\n\r\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\r\n private _osInstance: OverlayScrollbars | null = null;\r\n private _osTargetRef: RefObject<HTMLDivElement>;\r\n\r\n constructor(props: OverlayScrollbarsComponentProps) {\r\n super(props);\r\n this._osTargetRef = React.createRef();\r\n }\r\n\r\n osInstance(): OverlayScrollbars | null {\r\n return this._osInstance;\r\n }\r\n\r\n osTarget(): HTMLDivElement | null {\r\n return this._osTargetRef.current || null;\r\n }\r\n\r\n componentDidMount() {\r\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\r\n mergeHostClassNames(this._osInstance, this.props.className);\r\n }\r\n\r\n componentWillUnmount() {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.destroy();\r\n this._osInstance = null;\r\n }\r\n }\r\n\r\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\r\n if (OverlayScrollbars.valid(this._osInstance)) {\r\n this._osInstance.options(this.props.options);\r\n\r\n if (prevProps.className !== this.props.className) {\r\n mergeHostClassNames(this._osInstance, this.props.className);\r\n }\r\n }\r\n }\r\n\r\n render() {\r\n const {\r\n options,\r\n extensions,\r\n children,\r\n className,\r\n ...divProps\r\n } = this.props;\r\n\r\n return (\r\n <div className=\"os-host\" {...divProps} ref={this._osTargetRef}>\r\n <div className=\"os-resize-observer-host\"></div>\r\n <div className=\"os-padding\">\r\n <div className=\"os-viewport\">\r\n <div className=\"os-content\">\r\n {this.props.children}\r\n </div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar os-scrollbar-horizontal \">\r\n <div className=\"os-scrollbar-track\">\r\n <div className=\"os-scrollbar-handle\"></div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar os-scrollbar-vertical\">\r\n <div className=\"os-scrollbar-track\">\r\n <div className=\"os-scrollbar-handle\"></div>\r\n </div>\r\n </div>\r\n <div className=\"os-scrollbar-corner\"></div>\r\n </div>\r\n );\r\n }\r\n}\r\n\r\nfunction mergeHostClassNames(osInstance: OverlayScrollbars, className: string) {\r\n if (OverlayScrollbars.valid(osInstance)) {\r\n const { host } = osInstance.getElements();\r\n const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\\s/g, \"$|\")}$`, 'g');\r\n const osClassNames = host.className.split(' ')\r\n .filter(name => name.match(regex))\r\n .join(' ');\r\n\r\n host.className = `${osClassNames} ${className || ''}`;\r\n }\r\n}"],"names":["React","Component"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAUgD,8CAA2E;QAIvH,oCAAY,KAAsC;YAAlD,YACI,kBAAM,KAAK,CAAC,SAEf;YANO,iBAAW,GAA6B,IAAI,CAAC;YAKjD,KAAI,CAAC,YAAY,GAAGA,cAAK,CAAC,SAAS,EAAE,CAAC;;SACzC;QAED,+CAAU,GAAV;YACI,OAAO,IAAI,CAAC,WAAW,CAAC;SAC3B;QAED,6CAAQ,GAAR;YACI,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,IAAI,IAAI,CAAC;SAC5C;QAED,sDAAiB,GAAjB;YACI,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACvG,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;SAC/D;QAED,yDAAoB,GAApB;YACI,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBAC3C,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;gBAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;aAC3B;SACJ;QAED,uDAAkB,GAAlB,UAAmB,SAA0C;YACzD,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBAC3C,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE7C,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;oBAC9C,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;iBAC/D;aACJ;SACJ;QAED,2CAAM,GAAN;YACI,IAAM,eAMQ,EALV,oBAAO,EACP,0BAAU,EACV,sBAAQ,EACR,wBAAS,EACT,yEACU,CAAC;YAEf,QACIA,+CAAK,SAAS,EAAC,SAAS,IAAK,QAAQ,IAAE,GAAG,EAAE,IAAI,CAAC,YAAY;gBACzDA,sCAAK,SAAS,EAAC,yBAAyB,GAAO;gBAC/CA,sCAAK,SAAS,EAAC,YAAY;oBACvBA,sCAAK,SAAS,EAAC,aAAa;wBACxBA,sCAAK,SAAS,EAAC,YAAY,IACtB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAClB,CACJ,CACJ;gBACNA,sCAAK,SAAS,EAAC,uCAAuC;oBAClDA,sCAAK,SAAS,EAAC,oBAAoB;wBAC/BA,sCAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,CACJ;gBACNA,sCAAK,SAAS,EAAC,oCAAoC;oBAC/CA,sCAAK,SAAS,EAAC,oBAAoB;wBAC/BA,sCAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,CACJ;gBACNA,sCAAK,SAAS,EAAC,qBAAqB,GAAO,CACzC,EACR;SACL;QACL,iCAAC;IAAD,CAxEA,CAAgDC,eAAS,GAwExD;IAED,SAAS,mBAAmB,CAAC,UAA6B,EAAE,SAAiB;QACzE,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAA,oCAAI,CAA8B;YAC1C,IAAM,OAAK,GAAG,IAAI,MAAM,CAAC,0BAAwB,UAAU,CAAC,OAAO,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,MAAG,EAAE,GAAG,CAAC,CAAC;YAC9G,IAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;iBACzC,MAAM,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,CAAC,KAAK,CAAC,OAAK,CAAC,GAAA,CAAC;iBACjC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEf,IAAI,CAAC,SAAS,GAAM,YAAY,UAAI,SAAS,IAAI,EAAE,CAAE,CAAC;SACzD;IACL;;;;;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,53 +1,52 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "overlayscrollbars-react",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "OverlayScrollbars wrapper for React.",
|
|
5
|
-
"keywords": [
|
|
6
|
-
"overlayscrollbars",
|
|
7
|
-
"react"
|
|
8
|
-
],
|
|
9
|
-
"files": [
|
|
10
|
-
"src",
|
|
11
|
-
"dist"
|
|
12
|
-
],
|
|
13
|
-
"homepage": "https://kingsora.github.io/OverlayScrollbars",
|
|
14
|
-
"repository": {
|
|
15
|
-
"type": "git",
|
|
16
|
-
"url": "https://github.com/KingSora/OverlayScrollbars"
|
|
17
|
-
},
|
|
18
|
-
"bugs": {
|
|
19
|
-
"url": "https://github.com/KingSora/OverlayScrollbars/issues"
|
|
20
|
-
},
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
|
|
28
|
-
"@types/
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
"gulp": "^
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"rollup": "^1.
|
|
36
|
-
"rollup-plugin-
|
|
37
|
-
"rollup-plugin-
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
"
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
"
|
|
48
|
-
"
|
|
49
|
-
"example": "cd example && npm
|
|
50
|
-
"
|
|
51
|
-
|
|
52
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "overlayscrollbars-react",
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "OverlayScrollbars wrapper for React.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"overlayscrollbars",
|
|
7
|
+
"react"
|
|
8
|
+
],
|
|
9
|
+
"files": [
|
|
10
|
+
"src",
|
|
11
|
+
"dist"
|
|
12
|
+
],
|
|
13
|
+
"homepage": "https://kingsora.github.io/OverlayScrollbars",
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "https://github.com/KingSora/OverlayScrollbars"
|
|
17
|
+
},
|
|
18
|
+
"bugs": {
|
|
19
|
+
"url": "https://github.com/KingSora/OverlayScrollbars/issues"
|
|
20
|
+
},
|
|
21
|
+
"main": "./dist/overlayscrollbars-react.js",
|
|
22
|
+
"module": "./dist/overlayscrollbars-react.esm.js",
|
|
23
|
+
"typings": "./dist/types/index.d.ts",
|
|
24
|
+
"author": "KingSora | Rene Haas",
|
|
25
|
+
"license": "MIT",
|
|
26
|
+
"devDependencies": {
|
|
27
|
+
"@types/overlayscrollbars": "^1.9.0",
|
|
28
|
+
"@types/react": "^18.0.0",
|
|
29
|
+
"chalk": "^2.4.2",
|
|
30
|
+
"gulp": "^4.0.2",
|
|
31
|
+
"gulp-json-editor": "^2.5.4",
|
|
32
|
+
"overlayscrollbars": "^1.11.0",
|
|
33
|
+
"react": "^18.0.0",
|
|
34
|
+
"rollup": "^1.32.1",
|
|
35
|
+
"rollup-plugin-commonjs": "^10.1.0",
|
|
36
|
+
"rollup-plugin-node-resolve": "^5.2.0",
|
|
37
|
+
"rollup-plugin-typescript2": "^0.22.0",
|
|
38
|
+
"shelljs": "^0.8.3",
|
|
39
|
+
"typescript": "^3.8.3"
|
|
40
|
+
},
|
|
41
|
+
"peerDependencies": {
|
|
42
|
+
"react": "^16.4.0 || ^17.0.0 || ^18.0.0",
|
|
43
|
+
"overlayscrollbars": "^1.10.0"
|
|
44
|
+
},
|
|
45
|
+
"scripts": {
|
|
46
|
+
"setup": "npm i && cd example && npm i && cd ..",
|
|
47
|
+
"build": "node build.js",
|
|
48
|
+
"example": "cd example && npm start",
|
|
49
|
+
"build-example": "cd example && npm run build",
|
|
50
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
51
|
+
}
|
|
53
52
|
}
|
|
@@ -1,78 +1,95 @@
|
|
|
1
|
-
import React, { Component, RefObject } from 'react';
|
|
2
|
-
import OverlayScrollbars from "overlayscrollbars";
|
|
3
|
-
|
|
4
|
-
export interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
5
|
-
children?: any;
|
|
6
|
-
options?: OverlayScrollbars.Options;
|
|
7
|
-
extensions?: OverlayScrollbars.Extensions;
|
|
8
|
-
}
|
|
9
|
-
export interface OverlayScrollbarsComponentState { }
|
|
10
|
-
|
|
11
|
-
export class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {
|
|
12
|
-
private _osInstance: OverlayScrollbars | null = null;
|
|
13
|
-
private _osTargetRef: RefObject<HTMLDivElement>;
|
|
14
|
-
|
|
15
|
-
constructor(props: OverlayScrollbarsComponentProps) {
|
|
16
|
-
super(props);
|
|
17
|
-
this._osTargetRef = React.createRef();
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
osInstance(): OverlayScrollbars | null {
|
|
21
|
-
return this._osInstance;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
osTarget(): HTMLDivElement | null {
|
|
25
|
-
return this._osTargetRef.current || null;
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
componentDidMount() {
|
|
29
|
-
this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
this._osInstance
|
|
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
|
-
</div>
|
|
68
|
-
</div>
|
|
69
|
-
<div className="os-scrollbar os-scrollbar-
|
|
70
|
-
<div className="os-scrollbar-track">
|
|
71
|
-
<div className="os-scrollbar-handle"></div>
|
|
72
|
-
</div>
|
|
73
|
-
</div>
|
|
74
|
-
<div className="os-scrollbar-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
1
|
+
import React, { Component, RefObject } from 'react';
|
|
2
|
+
import OverlayScrollbars from "overlayscrollbars";
|
|
3
|
+
|
|
4
|
+
export interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {
|
|
5
|
+
children?: any;
|
|
6
|
+
options?: OverlayScrollbars.Options;
|
|
7
|
+
extensions?: OverlayScrollbars.Extensions;
|
|
8
|
+
}
|
|
9
|
+
export interface OverlayScrollbarsComponentState { }
|
|
10
|
+
|
|
11
|
+
export class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {
|
|
12
|
+
private _osInstance: OverlayScrollbars | null = null;
|
|
13
|
+
private _osTargetRef: RefObject<HTMLDivElement>;
|
|
14
|
+
|
|
15
|
+
constructor(props: OverlayScrollbarsComponentProps) {
|
|
16
|
+
super(props);
|
|
17
|
+
this._osTargetRef = React.createRef();
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
osInstance(): OverlayScrollbars | null {
|
|
21
|
+
return this._osInstance;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
osTarget(): HTMLDivElement | null {
|
|
25
|
+
return this._osTargetRef.current || null;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
componentDidMount() {
|
|
29
|
+
this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);
|
|
30
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
componentWillUnmount() {
|
|
34
|
+
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
35
|
+
this._osInstance.destroy();
|
|
36
|
+
this._osInstance = null;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {
|
|
41
|
+
if (OverlayScrollbars.valid(this._osInstance)) {
|
|
42
|
+
this._osInstance.options(this.props.options);
|
|
43
|
+
|
|
44
|
+
if (prevProps.className !== this.props.className) {
|
|
45
|
+
mergeHostClassNames(this._osInstance, this.props.className);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
render() {
|
|
51
|
+
const {
|
|
52
|
+
options,
|
|
53
|
+
extensions,
|
|
54
|
+
children,
|
|
55
|
+
className,
|
|
56
|
+
...divProps
|
|
57
|
+
} = this.props;
|
|
58
|
+
|
|
59
|
+
return (
|
|
60
|
+
<div className="os-host" {...divProps} ref={this._osTargetRef}>
|
|
61
|
+
<div className="os-resize-observer-host"></div>
|
|
62
|
+
<div className="os-padding">
|
|
63
|
+
<div className="os-viewport">
|
|
64
|
+
<div className="os-content">
|
|
65
|
+
{this.props.children}
|
|
66
|
+
</div>
|
|
67
|
+
</div>
|
|
68
|
+
</div>
|
|
69
|
+
<div className="os-scrollbar os-scrollbar-horizontal ">
|
|
70
|
+
<div className="os-scrollbar-track">
|
|
71
|
+
<div className="os-scrollbar-handle"></div>
|
|
72
|
+
</div>
|
|
73
|
+
</div>
|
|
74
|
+
<div className="os-scrollbar os-scrollbar-vertical">
|
|
75
|
+
<div className="os-scrollbar-track">
|
|
76
|
+
<div className="os-scrollbar-handle"></div>
|
|
77
|
+
</div>
|
|
78
|
+
</div>
|
|
79
|
+
<div className="os-scrollbar-corner"></div>
|
|
80
|
+
</div>
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
function mergeHostClassNames(osInstance: OverlayScrollbars, className: string) {
|
|
86
|
+
if (OverlayScrollbars.valid(osInstance)) {
|
|
87
|
+
const { host } = osInstance.getElements();
|
|
88
|
+
const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\s/g, "$|")}$`, 'g');
|
|
89
|
+
const osClassNames = host.className.split(' ')
|
|
90
|
+
.filter(name => name.match(regex))
|
|
91
|
+
.join(' ');
|
|
92
|
+
|
|
93
|
+
host.className = `${osClassNames} ${className || ''}`;
|
|
94
|
+
}
|
|
78
95
|
}
|