@arminmajerie/dockview-solid 4.5.0 → 4.5.3

package/README.md

@@ -1,38 +1,111 @@
 <div align="center">
-<h1>dockview</h1>
+  <h1>@arminmajerie/dockview-solid</h1>
+  <p>
+    Zero-dependency layout manager for <strong>SolidJS</strong>.<br>
+    <b>No React. No Vue. No legacy code.</b>
+  </p>
+  <p>
+    <a href="https://www.npmjs.com/package/@arminmajerie/dockview-solid">
+      <img src="https://img.shields.io/npm/v/@arminmajerie/dockview-solid?logo=npm" alt="npm version">
+    </a>
+    <a href="https://www.npmjs.com/package/@arminmajerie/dockview-solid">
+      <img src="https://img.shields.io/npm/dm/@arminmajerie/dockview-solid.svg" alt="npm downloads">
+    </a>
+  </p>
+</div>
 
-<p>Zero dependency layout manager supporting tabs, groups, grids and splitviews. Supports React, Vue and Vanilla TypeScript</p>
+---
 
-</div>
+**This package is for SolidJS.**
+It is NOT based on `solid-dockview` (outdated) or the React-dependent `dockview-solid` from mathuo/dockview.
 
 ---
 
-[![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)
+## Why this repo?
 
-##
+* `solid-dockview` ([lyonbot/solid-dockview](https://github.com/lyonbot/solid-dockview)): Outdated, not compatible, unmaintained.
+* `dockview-solid` ([mathuo/dockview/tree/main/packages/dockview-solid](https://github.com/mathuo/dockview/tree/main/packages/dockview-solid)): Thin React wrapper, **still requires React**.
 
-![](packages/docs/static/img/splashscreen.gif)
+**`@arminmajerie/dockview-solid`:**
 
-Please see the website: https://dockview.dev
+* ✅ Directly ported from [mathuo/dockview](https://github.com/mathuo/dockview)
+* ✅ 100% SolidJS (no React dependency, no React shims)
+* ✅ Works in SolidJS + Tauri applications
+
+---
 
 ## Features
 
--   Serialization / deserialization with full layout management
--   Support for split-views, grid-views and 'dockable' views
--   Themeable and customizable
--   Tab and Group docking / Drag n' Drop
--   Popout Windows
--   Floating Groups
--   Extensive API
--   Supports Shadow DOMs
--   High test coverage
--   Documentation website with live examples
--   Transparent builds and Code Analysis
--   Security at mind - verifed publishing and builds through GitHub Actions
-
-Want to verify our builds? Go [here](https://www.npmjs.com/package/dockview#Provenance).
+* Tabs, groups, grids, splitviews
+* Drag-and-drop with customizable drop zones
+* Floating groups and popout windows
+* Serialization/deserialization for state persistence
+* Theme system (CSS custom properties)
+* Full API for programmatic control
+* Works natively in SolidJS and Tauri
+* No React or legacy code
+
+---
+
+## Installation
+
+```sh
+npm install @arminmajerie/dockview-solid dockview-core solid-js
+```
+
+Both `@arminmajerie/dockview-solid` and `dockview-core` are required.
+
+---
+
+## Usage
+
+```js
+import "dockview-core/dist/styles/dockview.css";
+import {
+  DockviewSolid,
+  DockviewApi,
+  IDockviewPanelProps,
+  IDockviewPanelHeaderProps,
+  IDockviewHeaderActionsProps,
+  IWatermarkPanelProps,
+  DockviewReadyEvent,
+  IDockviewPanel,
+  themeReplit
+} from "@arminmajerie/dockview-solid";
+
+// Example component usage:
+
+<DockviewSolid
+  theme={themeReplit}
+  components={{ panelContent: PanelContent }}
+  tabComponents={{
+    customTabHeaderWorkspace: CustomTabHeaderWithCloseButton,
+    customTabHeaderConfig: CustomTabHeaderWithCloseButton,
+    customTabHeaderComponent: CustomTabHeaderWithCloseButton,
+    customTabHeaderCanvas: CustomTabHeaderNoClosing,
+  }}
+  rightHeaderActionsComponent={AddPanel}
+  watermarkComponent={MyWatermark}
+  onReady={handleReady}
+/>
+```
+
+---
+
+## Project status
+
+* **Alpha:** Major features are ported, but expect bugs and breaking changes.
+* **Docs and live examples:** Coming soon.
+* **No support for React/Vue.**
+
+---
+
+## License
+
+MIT
+
+---
+
+## Maintainer
+
+* [arminmajerie](https://github.com/arminmajerie)

package/dist/cjs/index.d.ts

@@ -1 +1 @@
-export * from 'dockview';
+export * from '@arminmajerie/dockview';

package/dist/cjs/index.js

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("dockview"), exports);
+__exportStar(require("@arminmajerie/dockview"), exports);

package/dist/esm/index.d.ts

@@ -1 +1 @@
-export * from 'dockview';
+export * from '@arminmajerie/dockview';

package/dist/esm/index.js

@@ -1 +1 @@
-export * from 'dockview';
+export * from '@arminmajerie/dockview';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arminmajerie/dockview-solid",
-  "version": "4.5.0",
+  "version": "4.5.3",
   "description": "Zero dependency layout manager supporting tabs, grids and splitviews (SolidJS version)",
   "keywords": [
     "solid",
@@ -57,7 +57,7 @@
     "rebuild": "npm run clean && npm run build"
   },
   "dependencies": {
-    "dockview": "file:../dockview"
+    "@arminmajerie/dockview": "^4.5.3"
   },
   "peerDependencies": {
     "solid-js": "^1.8.0"