dockview 7.0.4 → 8.1.0

package/LICENCE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 mathuo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,22 +1,26 @@
 <div align="center">
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/dockview/dockview/blob/HEAD/static/img/dockview-lockup-dark.svg?raw=true">
+  <img src="https://github.com/dockview/dockview/blob/HEAD/static/img/dockview-lockup-light.svg?raw=true" alt="Dockview" width="480">
+</picture>
+
 <h1>dockview</h1>
 
 <p>Zero dependency layout manager supporting tabs, groups, grids and splitviews</p>
 
+[![npm version](https://img.shields.io/npm/v/dockview)](https://www.npmjs.com/package/dockview)
+[![npm downloads](https://img.shields.io/npm/dm/dockview)](https://www.npmjs.com/package/dockview)
+[![CI](https://img.shields.io/github/actions/workflow/status/dockview/dockview/main.yml?branch=master&label=CI)](https://github.com/dockview/dockview/actions?query=workflow%3ACI)
+[![Coverage](https://img.shields.io/sonar/coverage/dockview_dockview?server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/summary/overall?id=dockview_dockview)
+[![Quality gate](https://img.shields.io/sonar/quality_gate/dockview_dockview?server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/summary/overall?id=dockview_dockview)
+[![Bundle size](https://img.shields.io/bundlephobia/minzip/dockview?label=size)](https://bundlephobia.com/result?p=dockview)
+
 </div>
 
 ---
 
-[![npm version](https://badge.fury.io/js/dockview.svg)](https://www.npmjs.com/package/dockview)
-[![npm](https://img.shields.io/npm/dm/dockview)](https://www.npmjs.com/package/dockview)
-[![CI Build](https://github.com/mathuo/dockview/workflows/CI/badge.svg)](https://github.com/mathuo/dockview/actions?query=workflow%3ACI)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=coverage)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mathuo_dockview&metric=alert_status)](https://sonarcloud.io/summary/overall?id=mathuo_dockview)
-[![Bundle Phobia](https://badgen.net/bundlephobia/minzip/dockview)](https://bundlephobia.com/result?p=dockview)
-
-##
-
-![](https://github.com/mathuo/dockview/blob/HEAD/packages/docs/static/img/splashscreenv2.png?raw=true)
+![A Dockview layout showing docked, tabbed and split panels in a trading workbench](https://github.com/dockview/dockview/blob/HEAD/static/img/demo-hero.webp?raw=true)
 
 Please see the website: https://dockview.dev
 
@@ -36,7 +40,7 @@ Please see the website: https://dockview.dev
 -   High test coverage
 -   Documentation website with live examples
 -   Transparent builds and Code Analysis
--   Security at mind - verified publishing and builds through GitHub Actions
+-   Security in mind - verified publishing and builds through GitHub Actions
 
 ## Quick Start
 
@@ -57,14 +61,15 @@ Import the stylesheet:
 @import 'dockview/dist/styles/dockview.css';
 ```
 
-Create a dockview instance:
+Create a dockview instance and pass a theme:
 
 ```ts
-import { DockviewComponent } from 'dockview';
+import { DockviewComponent, themeDark } from 'dockview';
 
 const element = document.getElementById('app');
 
 const dockview = new DockviewComponent(element, {
+    theme: themeDark,
     createComponent: (options) => {
         switch (options.name) {
             case 'my-component':
@@ -83,8 +88,6 @@ dockview.addPanel({
 });
 ```
 
-Apply a theme by adding a theme class (e.g. `dockview-theme-dark`) to a parent element.
-
 See the [documentation](https://dockview.dev) for full examples.
 
 Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview#Provenance).

package/dist/cjs/index.d.ts

@@ -1 +1,10 @@
 export * from 'dockview-core';
+/**
+ * `dockview` is the recommended free entry point: a thin re-export of
+ * `dockview-core`. The separable enterprise feature modules live in the
+ * separately-published `dockview-enterprise` package (which depends on and
+ * re-exports `dockview`); install that to opt into them.
+ *
+ * This module has no side effects (it's a pure re-export), so bundlers can
+ * fully tree-shake unused exports out of consumer builds.
+ */