overlayscrollbars-react 0.2.3 → 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/README.md CHANGED
@@ -3,7 +3,7 @@
3
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
4
  </p>
5
5
  <h6 align="center">
6
- <a href="https://github.com/facebook/react/"><img src="https://img.shields.io/badge/React-%5E16.4.0-61dafb?style=flat-square&logo=React" alt="React"></a>
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
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
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
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>
@@ -20,77 +20,98 @@
20
20
  </h5>
21
21
 
22
22
  ## Installation
23
+
23
24
  ```sh
24
25
  npm install overlayscrollbars-react
25
26
  ```
26
27
 
27
28
  ## Peer Dependencies
29
+
28
30
  OverlayScrollbars for React has the following **peer dependencies**:
29
- - The vanilla JavaScript library: [overlayscrollbars](https://www.npmjs.com/package/overlayscrollbars)
31
+
32
+ - The vanilla JavaScript library: [overlayscrollbars](https://www.npmjs.com/package/overlayscrollbars)
33
+
30
34
  ```
31
35
  npm install overlayscrollbars
32
36
  ```
37
+
33
38
  - The React framework: [react](https://www.npmjs.com/package/react)
39
+
34
40
  ```
35
41
  npm install react
36
42
  ```
37
43
 
38
44
  ## TypeScript
45
+
39
46
  - In case you are using TypeScript, you have to install the [OverlayScrollbars typings](https://www.npmjs.com/package/@types/overlayscrollbars):
47
+
40
48
  ```
41
49
  npm install @types/overlayscrollbars
42
50
  ```
51
+
43
52
  Since this wrapper is written in TypeScript it comes with its generated typings.<br>
44
53
  Check out the [recommended](https://github.com/KingSora/OverlayScrollbars#typescript) **tsconfig.json** options.
45
54
 
46
55
  ## Usage
56
+
47
57
  #### CSS
58
+
48
59
  You have to import the `OverlayScrollbars.css` by yourself.<br>
49
60
  The component **doesn't** do it for you as the styles are **global styles**!<br>
50
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
+
51
63
  ```js
52
- import 'overlayscrollbars/css/OverlayScrollbars.css';
64
+ import "overlayscrollbars/css/OverlayScrollbars.css";
53
65
  ```
54
66
 
55
67
  #### Import
68
+
56
69
  Simply import the component into your file(s):
70
+
57
71
  ```js
58
- import { OverlayScrollbarsComponent } from 'overlayscrollbars-react';
72
+ import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
59
73
  ```
60
74
 
61
75
  #### Template
76
+
62
77
  After the import you can use it in JSX:
78
+
63
79
  ```jsx
64
- <OverlayScrollbarsComponent>
65
- example content
66
- </OverlayScrollbarsComponent>
80
+ <OverlayScrollbarsComponent>example content</OverlayScrollbarsComponent>
67
81
  ```
68
82
 
69
83
  #### Properties
84
+
70
85
  Two properties are accepted: `options` and `extensions`.
86
+
71
87
  - The `options` property accepts a `object` and can be changed at any point in time, and the plugin will adapt.
72
88
  - The `extensions` property accepts a `string`, `string array` or `object` and is only taken into account if the component gets mounted.
73
89
 
74
90
  ```jsx
75
91
  <OverlayScrollbarsComponent
76
- options={{ scrollbars: { autoHide: 'scroll' } }}
77
- extensions={['extensionA', 'extensionB']}
78
- >
79
- </OverlayScrollbarsComponent>
92
+ options={{ scrollbars: { autoHide: "scroll" } }}
93
+ extensions={["extensionA", "extensionB"]}
94
+ ></OverlayScrollbarsComponent>
80
95
  ```
96
+
81
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).
82
98
 
83
99
  #### Instance
100
+
84
101
  If you get the component reference, it provides two methods: `osInstance()` and `osTarget()`.
102
+
85
103
  - The `osInstance()` method returns the OverlayScrollbars `instance` of the component, or `null` if the instance isn't initialized yet or already destroyed.
86
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.
87
105
 
88
106
  ## Example App
107
+
89
108
  In case you need a example app for reference, you can use the example app in this repo(`example folder`):
109
+
90
110
  - [Live example](https://kingsora.github.io/OverlayScrollbars/frameworks/react/)
91
111
  - [Source code](https://github.com/KingSora/OverlayScrollbars/tree/master/packages/overlayscrollbars-react/example)
92
112
 
93
113
  If you wanna build the example app, run these commands:
114
+
94
115
  ```sh
95
116
  npm run setup
96
117
  npm run build
@@ -99,4 +120,4 @@ npm run example
99
120
 
100
121
  ## License
101
122
 
102
- MIT
123
+ MIT
@@ -1,6 +1,6 @@
1
- import React, { Component } from 'react';
2
- import OverlayScrollbars from 'overlayscrollbars';
3
-
1
+ import React, { Component } from 'react';
2
+ import OverlayScrollbars from 'overlayscrollbars';
3
+
4
4
  /*! *****************************************************************************
5
5
  Copyright (c) Microsoft Corporation. All rights reserved.
6
6
  Licensed under the Apache License, Version 2.0 (the "License"); you may not use
@@ -26,8 +26,8 @@ function __rest(s, e) {
26
26
  t[p[i]] = s[p[i]];
27
27
  }
28
28
  return t;
29
- }
30
-
29
+ }
30
+
31
31
  class OverlayScrollbarsComponent extends Component {
32
32
  constructor(props) {
33
33
  super(props);
@@ -83,7 +83,7 @@ function mergeHostClassNames(osInstance, className) {
83
83
  .join(' ');
84
84
  host.className = `${osClassNames} ${className || ''}`;
85
85
  }
86
- }
87
-
88
- export { OverlayScrollbarsComponent };
89
- //# sourceMappingURL=overlayscrollbars-react.esm.js.map
86
+ }
87
+
88
+ export { OverlayScrollbarsComponent };
89
+ //# sourceMappingURL=overlayscrollbars-react.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.esm.js","sources":["../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import React, { Component, RefObject } from 'react';\nimport OverlayScrollbars from \"overlayscrollbars\";\n\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\n children?: any;\n options?: OverlayScrollbars.Options;\n extensions?: OverlayScrollbars.Extensions;\n}\nexport interface OverlayScrollbarsComponentState { }\n\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\n private _osInstance: OverlayScrollbars | null = null;\n private _osTargetRef: RefObject<HTMLDivElement>;\n\n constructor(props: OverlayScrollbarsComponentProps) {\n super(props);\n this._osTargetRef = React.createRef();\n }\n\n osInstance(): OverlayScrollbars | null {\n return this._osInstance;\n }\n\n osTarget(): HTMLDivElement | null {\n return this._osTargetRef.current || null;\n }\n\n componentDidMount() {\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\n mergeHostClassNames(this._osInstance, this.props.className);\n }\n\n componentWillUnmount() {\n if (OverlayScrollbars.valid(this._osInstance)) {\n this._osInstance.destroy();\n this._osInstance = null;\n }\n }\n\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\n if (OverlayScrollbars.valid(this._osInstance)) {\n this._osInstance.options(this.props.options);\n\n if (prevProps.className !== this.props.className) {\n mergeHostClassNames(this._osInstance, this.props.className);\n }\n }\n }\n\n render() {\n const {\n options,\n extensions,\n children,\n className,\n ...divProps\n } = this.props;\n\n return (\n <div className=\"os-host\" {...divProps} ref={this._osTargetRef}>\n <div className=\"os-resize-observer-host\"></div>\n <div className=\"os-padding\">\n <div className=\"os-viewport\">\n <div className=\"os-content\">\n {this.props.children}\n </div>\n </div>\n </div>\n <div className=\"os-scrollbar os-scrollbar-horizontal \">\n <div className=\"os-scrollbar-track\">\n <div className=\"os-scrollbar-handle\"></div>\n </div>\n </div>\n <div className=\"os-scrollbar os-scrollbar-vertical\">\n <div className=\"os-scrollbar-track\">\n <div className=\"os-scrollbar-handle\"></div>\n </div>\n </div>\n <div className=\"os-scrollbar-corner\"></div>\n </div>\n );\n }\n}\n\nfunction mergeHostClassNames(osInstance: OverlayScrollbars, className: string) {\n if (OverlayScrollbars.valid(osInstance)) {\n const { host } = osInstance.getElements();\n const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\\s/g, \"$|\")}$`, 'g');\n const osClassNames = host.className.split(' ')\n .filter(name => name.match(regex))\n .join(' ');\n\n host.className = `${osClassNames} ${className || ''}`;\n }\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;;;;"}
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;;;;"}
@@ -1,12 +1,12 @@
1
- (function (global, factory) {
2
- typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react'), require('overlayscrollbars')) :
3
- typeof define === 'function' && define.amd ? define(['exports', 'react', 'overlayscrollbars'], factory) :
4
- (global = global || self, factory(global.OverlayScrollbarsReact = {}, global.React, global.OverlayScrollbars));
5
- }(this, (function (exports, React, OverlayScrollbars) { 'use strict';
6
-
7
- var React__default = 'default' in React ? React['default'] : React;
8
- OverlayScrollbars = OverlayScrollbars && Object.prototype.hasOwnProperty.call(OverlayScrollbars, 'default') ? OverlayScrollbars['default'] : OverlayScrollbars;
9
-
1
+ (function (global, factory) {
2
+ typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react'), require('overlayscrollbars')) :
3
+ typeof define === 'function' && define.amd ? define(['exports', 'react', 'overlayscrollbars'], factory) :
4
+ (global = global || self, factory(global.OverlayScrollbarsReact = {}, global.React, global.OverlayScrollbars));
5
+ }(this, (function (exports, React, OverlayScrollbars) { 'use strict';
6
+
7
+ var React__default = 'default' in React ? React['default'] : React;
8
+ OverlayScrollbars = OverlayScrollbars && Object.prototype.hasOwnProperty.call(OverlayScrollbars, 'default') ? OverlayScrollbars['default'] : OverlayScrollbars;
9
+
10
10
  /*! *****************************************************************************
11
11
  Copyright (c) Microsoft Corporation. All rights reserved.
12
12
  Licensed under the Apache License, Version 2.0 (the "License"); you may not use
@@ -57,8 +57,8 @@
57
57
  t[p[i]] = s[p[i]];
58
58
  }
59
59
  return t;
60
- }
61
-
60
+ }
61
+
62
62
  var OverlayScrollbarsComponent = (function (_super) {
63
63
  __extends(OverlayScrollbarsComponent, _super);
64
64
  function OverlayScrollbarsComponent(props) {
@@ -117,11 +117,11 @@
117
117
  .join(' ');
118
118
  host.className = osClassNames + " " + (className || '');
119
119
  }
120
- }
121
-
122
- exports.OverlayScrollbarsComponent = OverlayScrollbarsComponent;
123
-
124
- Object.defineProperty(exports, '__esModule', { value: true });
125
-
126
- })));
127
- //# sourceMappingURL=overlayscrollbars-react.js.map
120
+ }
121
+
122
+ exports.OverlayScrollbarsComponent = OverlayScrollbarsComponent;
123
+
124
+ Object.defineProperty(exports, '__esModule', { value: true });
125
+
126
+ })));
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';\nimport OverlayScrollbars from \"overlayscrollbars\";\n\nexport interface OverlayScrollbarsComponentProps extends React.HTMLAttributes<HTMLDivElement> {\n children?: any;\n options?: OverlayScrollbars.Options;\n extensions?: OverlayScrollbars.Extensions;\n}\nexport interface OverlayScrollbarsComponentState { }\n\nexport class OverlayScrollbarsComponent extends Component<OverlayScrollbarsComponentProps, OverlayScrollbarsComponentState> {\n private _osInstance: OverlayScrollbars | null = null;\n private _osTargetRef: RefObject<HTMLDivElement>;\n\n constructor(props: OverlayScrollbarsComponentProps) {\n super(props);\n this._osTargetRef = React.createRef();\n }\n\n osInstance(): OverlayScrollbars | null {\n return this._osInstance;\n }\n\n osTarget(): HTMLDivElement | null {\n return this._osTargetRef.current || null;\n }\n\n componentDidMount() {\n this._osInstance = OverlayScrollbars(this.osTarget(), this.props.options || {}, this.props.extensions);\n mergeHostClassNames(this._osInstance, this.props.className);\n }\n\n componentWillUnmount() {\n if (OverlayScrollbars.valid(this._osInstance)) {\n this._osInstance.destroy();\n this._osInstance = null;\n }\n }\n\n componentDidUpdate(prevProps: OverlayScrollbarsComponentProps) {\n if (OverlayScrollbars.valid(this._osInstance)) {\n this._osInstance.options(this.props.options);\n\n if (prevProps.className !== this.props.className) {\n mergeHostClassNames(this._osInstance, this.props.className);\n }\n }\n }\n\n render() {\n const {\n options,\n extensions,\n children,\n className,\n ...divProps\n } = this.props;\n\n return (\n <div className=\"os-host\" {...divProps} ref={this._osTargetRef}>\n <div className=\"os-resize-observer-host\"></div>\n <div className=\"os-padding\">\n <div className=\"os-viewport\">\n <div className=\"os-content\">\n {this.props.children}\n </div>\n </div>\n </div>\n <div className=\"os-scrollbar os-scrollbar-horizontal \">\n <div className=\"os-scrollbar-track\">\n <div className=\"os-scrollbar-handle\"></div>\n </div>\n </div>\n <div className=\"os-scrollbar os-scrollbar-vertical\">\n <div className=\"os-scrollbar-track\">\n <div className=\"os-scrollbar-handle\"></div>\n </div>\n </div>\n <div className=\"os-scrollbar-corner\"></div>\n </div>\n );\n }\n}\n\nfunction mergeHostClassNames(osInstance: OverlayScrollbars, className: string) {\n if (OverlayScrollbars.valid(osInstance)) {\n const { host } = osInstance.getElements();\n const regex = new RegExp(`(^os-host([-_].+|)$)|${osInstance.options().className.replace(/\\s/g, \"$|\")}$`, 'g');\n const osClassNames = host.className.split(' ')\n .filter(name => name.match(regex))\n .join(' ');\n\n host.className = `${osClassNames} ${className || ''}`;\n }\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;;;;;;;;;;;;"}
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,52 +1,52 @@
1
- {
2
- "name": "overlayscrollbars-react",
3
- "version": "0.2.3",
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": "^16.9.27",
29
- "chalk": "^2.4.2",
30
- "gulp": "^4.0.2",
31
- "gulp-json-editor": "^2.5.4",
32
- "overlayscrollbars": "^1.11.0",
33
- "react": "^16.13.1",
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",
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
- }
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
+ }
52
+ }