@linzjs/windows 3.2.1 → 3.2.2
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 +12 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,22 +1,28 @@
|
|
|
1
1
|
# @linzjs/windows
|
|
2
2
|
|
|
3
|
-
[](https://github.com/semantic-release/semantic-release)
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
> Reusable promise based windowing component for LINZ / Toitū te whenua.
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
React state based modals/windows are painful because they require:
|
|
9
9
|
- shared states for open/closed.
|
|
10
10
|
- callbacks/states for return values.
|
|
11
|
-
- inline modal/window includes, which prevent you from closing the invoking component before the modal/window has
|
|
12
|
-
|
|
11
|
+
- inline modal/window includes, which prevent you from closing the invoking component before the modal/window has completed.
|
|
12
|
+
- multi-window dialogs
|
|
13
|
+
- html5 dialog based
|
|
13
14
|
|
|
14
15
|
This module gives you promise based modals/windows which don't require all the state
|
|
15
|
-
based
|
|
16
|
+
based boilerplate / inline-components.
|
|
17
|
+
|
|
18
|
+
So you can simply do this in your react-app:
|
|
19
|
+
```
|
|
20
|
+
const result = await showModal(TestModal)
|
|
21
|
+
```
|
|
16
22
|
|
|
17
23
|
## Features
|
|
18
24
|
- Async HTML dialog based Modals.
|
|
19
|
-
- Draggable and resizeable, pop-in/out Windows.
|
|
25
|
+
- Draggable and resizeable, pop-in/out Panels/Windows.
|
|
20
26
|
|
|
21
27
|
## Install
|
|
22
28
|
```
|