dockview-react 0.0.0-beta-0 → 1.14.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
@@ -1,56 +1,56 @@
1
- <div align="center">
2
- <h1>dockview</h1>
3
-
4
- <p>Zero dependency layout manager supporting tabs, groups, grids and splitviews with ReactJS support written in TypeScript</p>
5
-
6
- </div>
7
-
8
- ---
9
-
10
- [![npm version](https://badge.fury.io/js/dockview.svg)](https://www.npmjs.com/package/dockview)
11
- [![npm](https://img.shields.io/npm/dm/dockview)](https://www.npmjs.com/package/dockview)
12
- [![CI Build](https://github.com/mathuo/dockview/workflows/CI/badge.svg)](https://github.com/mathuo/dockview/actions?query=workflow%3ACI)
13
- [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=coverage)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
14
- [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
15
- [![Bundle Phobia](https://badgen.net/bundlephobia/minzip/dockview)](https://bundlephobia.com/result?p=dockview)
16
-
17
- ##
18
-
19
- Please see the website: https://dockview.dev
20
-
21
- ## Features
22
-
23
- - Serialization / deserialization with full layout management
24
- - Support for split-views, grid-views and 'dockable' views
25
- - Themeable and customizable
26
- - Tab and Group docking / Drag n' Drop
27
- - Popout Windows
28
- - Floating Groups
29
- - Extensive API
30
- - Supports Shadow DOMs
31
- - High test coverage
32
- - Documentation website with live examples
33
- - Transparent builds and Code Analysis
34
- - Security at mind - verifed publishing and builds through GitHub Actions
35
-
36
- Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview#Provenance).
37
-
38
- ## Quick start
39
-
40
- Dockview has a peer dependency on `react >= 16.8.0` and `react-dom >= 16.8.0`. You can install dockview from [npm](https://www.npmjs.com/package/dockview).
41
-
42
- ```
43
- npm install --save dockview
44
- ```
45
-
46
- Within your project you must import or reference the stylesheet at `dockview/dist/styles/dockview.css` and attach a theme.
47
-
48
- ```css
49
- @import '~dockview/dist/styles/dockview.css';
50
- ```
51
-
52
- You should also attach a dockview theme to an element containing your components. For example:
53
-
54
- ```html
55
- <body classname="dockview-theme-dark"></body>
56
- ```
1
+ <div align="center">
2
+ <h1>dockview</h1>
3
+
4
+ <p>Zero dependency layout manager supporting tabs, groups, grids and splitviews with ReactJS support written in TypeScript</p>
5
+
6
+ </div>
7
+
8
+ ---
9
+
10
+ [![npm version](https://badge.fury.io/js/dockview.svg)](https://www.npmjs.com/package/dockview)
11
+ [![npm](https://img.shields.io/npm/dm/dockview)](https://www.npmjs.com/package/dockview)
12
+ [![CI Build](https://github.com/mathuo/dockview/workflows/CI/badge.svg)](https://github.com/mathuo/dockview/actions?query=workflow%3ACI)
13
+ [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=coverage)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
14
+ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
15
+ [![Bundle Phobia](https://badgen.net/bundlephobia/minzip/dockview)](https://bundlephobia.com/result?p=dockview)
16
+
17
+ ##
18
+
19
+ Please see the website: https://dockview.dev
20
+
21
+ ## Features
22
+
23
+ - Serialization / deserialization with full layout management
24
+ - Support for split-views, grid-views and 'dockable' views
25
+ - Themeable and customizable
26
+ - Tab and Group docking / Drag n' Drop
27
+ - Popout Windows
28
+ - Floating Groups
29
+ - Extensive API
30
+ - Supports Shadow DOMs
31
+ - High test coverage
32
+ - Documentation website with live examples
33
+ - Transparent builds and Code Analysis
34
+ - Security at mind - verifed publishing and builds through GitHub Actions
35
+
36
+ Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview#Provenance).
37
+
38
+ ## Quick start
39
+
40
+ Dockview has a peer dependency on `react >= 16.8.0` and `react-dom >= 16.8.0`. You can install dockview from [npm](https://www.npmjs.com/package/dockview).
41
+
42
+ ```
43
+ npm install --save dockview
44
+ ```
45
+
46
+ Within your project you must import or reference the stylesheet at `dockview/dist/styles/dockview.css` and attach a theme.
47
+
48
+ ```css
49
+ @import '~dockview/dist/styles/dockview.css';
50
+ ```
51
+
52
+ You should also attach a dockview theme to an element containing your components. For example:
53
+
54
+ ```html
55
+ <body classname="dockview-theme-dark"></body>
56
+ ```