react-bounded-overlay-manager 1.0.0-beta.2 → 1.0.1
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 +21 -0
- package/README.md +6 -3
- package/package.json +41 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 metincansiper
|
|
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
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
`React Bounded Overlay Manager` is a React library designed to create and manage overlay components within a specified bounding container. It offers flexible positioning, dynamic show/hide behavior, customizable event handling, and an API for extended control.
|
|
5
|
+
`React Bounded Overlay Manager` is a React library, with TypeScript support, designed to create and manage overlay components within a specified bounding container. It offers flexible positioning, dynamic show/hide behavior, customizable event handling, and an API for extended control.
|
|
6
6
|
|
|
7
7
|
## Key Features
|
|
8
8
|
|
|
@@ -27,17 +27,20 @@ const BasicExample = () => {
|
|
|
27
27
|
const boundingComponentRef = useRef(null);
|
|
28
28
|
|
|
29
29
|
return (
|
|
30
|
-
|
|
30
|
+
<>
|
|
31
31
|
<div ref={boundingComponentRef} style={{ width: '70vw', height: '50vh', border: '1px solid black' }}>
|
|
32
32
|
Hover over this div to display overlays.
|
|
33
33
|
</div>
|
|
34
|
+
{/*
|
|
35
|
+
The BoundedOverlayManager component can be flexibly placed anywhere within the React component tree of your application's JSX. Its internal logic will handle the actual rendering location of overlays, ensuring consistent functionality regardless of its position in the JSX.
|
|
36
|
+
*/}
|
|
34
37
|
<BoundedOverlayManager boundingComponentRef={boundingComponentRef}>
|
|
35
38
|
<Overlay position={PredefinedPosition.BOTTOM_CENTER}>
|
|
36
39
|
<button>Overlay Button</button>
|
|
37
40
|
</Overlay>
|
|
38
41
|
<!-- more overlays here -->
|
|
39
42
|
</BoundedOverlayManager>
|
|
40
|
-
|
|
43
|
+
</>
|
|
41
44
|
);
|
|
42
45
|
};
|
|
43
46
|
```
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "react-bounded-overlay-manager",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.1",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/main.js",
|
|
7
7
|
"types": "dist/main.d.ts",
|
|
@@ -70,5 +70,44 @@
|
|
|
70
70
|
"dependencies": {
|
|
71
71
|
"events": "^3.3.0",
|
|
72
72
|
"use-debounce": "^10.0.0"
|
|
73
|
-
}
|
|
73
|
+
},
|
|
74
|
+
"license": "MIT",
|
|
75
|
+
"repository": {
|
|
76
|
+
"type": "git",
|
|
77
|
+
"url": "https://github.com/metincansiper/react-bounded-overlay-manager"
|
|
78
|
+
},
|
|
79
|
+
"keywords": [
|
|
80
|
+
"react",
|
|
81
|
+
"overlay",
|
|
82
|
+
"customizable",
|
|
83
|
+
"extendable",
|
|
84
|
+
"flexible",
|
|
85
|
+
"dynamic-visibility",
|
|
86
|
+
"react-overlay",
|
|
87
|
+
"overlay-manager",
|
|
88
|
+
"manager",
|
|
89
|
+
"controller",
|
|
90
|
+
"interactive-ui",
|
|
91
|
+
"relative",
|
|
92
|
+
"absolute",
|
|
93
|
+
"positioning",
|
|
94
|
+
"position",
|
|
95
|
+
"offset",
|
|
96
|
+
"component-library",
|
|
97
|
+
"event-based",
|
|
98
|
+
"user-interaction",
|
|
99
|
+
"responsive",
|
|
100
|
+
"interface-enhancement",
|
|
101
|
+
"ui-library",
|
|
102
|
+
"react-components",
|
|
103
|
+
"dynamic-content",
|
|
104
|
+
"popup",
|
|
105
|
+
"tooltip",
|
|
106
|
+
"popover",
|
|
107
|
+
"modal",
|
|
108
|
+
"typescript",
|
|
109
|
+
"ui-components",
|
|
110
|
+
"react-ui",
|
|
111
|
+
"frontend"
|
|
112
|
+
]
|
|
74
113
|
}
|