react-simple-dock 0.1.1 → 0.1.3

package/README.md

@@ -2,12 +2,18 @@
 
 A set of React components to create a dockable interface, allowing to arrange and resize tabs.
 
-## Installation
+## Installation of the javascript package
 
 ```bash
 npm install react-simple-dock
 ```
 
+## Installation of the PRET python package
+
+```bash
+pip install pret-simple-dock
+```
+
 ## Demo
 
 [![Edit react-simple-dock](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/zwgwp3)
@@ -16,6 +22,7 @@ npm install react-simple-dock
 
 ```tsx
 import React from "react";
+import ReactDOM from "react-dom";
 import { Layout, Panel } from "react-simple-dock";
 import { DndProvider } from "react-dnd";
 import { HTML5Backend } from "react-dnd-html5-backend";
@@ -37,25 +44,74 @@ const DEFAULT_CONFIG = {
 };
 
 const App = () => (
-    <DndProvider backend={HTML5Backend}>
-        <div style={{ background: "#bdbdbd", width: "100vw", height: "100vh" }}>
-            <Layout
-                /* optional initial layout config */
-                defaultConfig={DEFAULT_CONFIG}
-            >
-                <Panel key="Panel 1">
-                    <p>Content 1</p>
-                </Panel>
-                <Panel key="Panel 2" header={<i>Italic title</i>}>
-                    <p>Content 2</p>
-                </Panel>
-                <Panel key="Panel 3">
-                    <p>Content 3</p>
-                </Panel>
-            </Layout>
-        </div>
-    </DndProvider>
+    <div style={{ background: "#bdbdbd", width: "100vw", height: "100vh" }}>
+        <Layout
+            /* optional initial layout config */
+            defaultConfig={DEFAULT_CONFIG}
+        >
+            <Panel key="Panel 1">
+                <p>Content 1</p>
+            </Panel>
+            <Panel key="Panel 2" header={<i>Italic title</i>}>
+                <p>Content 2</p>
+            </Panel>
+            <Panel key="Panel 3">
+                <p>Content 3</p>
+            </Panel>
+        </Layout>
+    </div>
 );
 
 ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(<App />);
 ```
+
+## Development
+
+### Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/percevalw/react-simple-dock.git
+cd react-simple-dock
+```
+
+Install the dependencies:
+
+```bash
+yarn install
+```
+
+Make your changes and run the demo:
+
+```bash
+yarn start
+```
+
+### Build the javascript library
+
+To build the javascript library:
+
+```bash
+yarn build:lib
+```
+
+### Build the PRET python package
+
+Ensure `pret` is installed.
+
+```bash
+pip install pret
+```
+
+If you have changed the signature of the components, you will need to update the python stubs.
+
+```bash
+pret stub . SimpleDock pret/ui/simple_dock/__init__.py
+```
+
+To build the python library and make it available in your environment:
+
+```bash
+pip install .
+```

package/{dist/index.d.ts → index.d.ts}

@@ -7,3 +7,8 @@ export declare function Layout(props: {
     defaultConfig?: LayoutConfig;
     wrapDnd?: boolean;
 }): import("react/jsx-runtime").JSX.Element;
+export declare namespace Layout {
+    var defaultProps: {
+        wrapDnd: boolean;
+    };
+}

package/{dist/index.js → index.js}

@@ -378,3 +378,6 @@ export function Layout(props) {
     }
     return container;
 }
+Layout.defaultProps = {
+    wrapDnd: true,
+};

package/package.json

@@ -1,65 +1,17 @@
 {
   "name": "react-simple-dock",
-  "version": "0.1.1",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "type": "module",
+  "version": "0.1.3",
+  "main": "index.js",
   "description": "Simple dock component for React",
   "repository": "https://github.com/percevalw/react-simple-dock",
   "author": "Perceval Wajsbürt <perceval.wajsburt@gmail.com>",
-  "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject",
-    "build:lib:babel": "rm -rf dist && NODE_ENV=production babel src/lib --out-dir dist --copy-files --ignore __tests__,spec.js,test.js,__snapshots__,*.md",
-    "build:lib": "rm -rf dist && tsc --build tsconfig.lib.json && cp src/lib/*.css dist && rm -rf lib/",
-    "prepublishOnly": "npm run build:lib",
-    "build:pret": "jlpm clean && jupyter labextension build .",
-    "build:pret:dev": "jlpm clean && jupyter labextension build --development True .",
-    "clean": "rm -rf pret/ui/simple_dock/js-extension lib",
-    "prepare": "husky install"
-  },
   "dependencies": {
     "react-dnd": ">=16.0.1",
     "react-dnd-html5-backend": ">=16.0.1"
   },
   "peerDependencies": {
-    "@types/react": ">= 16",
-    "react": ">=16.0.0",
-    "react-dom": ">=16.0.0"
-  },
-  "devDependencies": {
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.2.0",
-    "@testing-library/user-event": "^13.5.0",
-    "@types/jest": "^27.5.2",
-    "@types/node": "^16.18.126",
-    "@types/react": "^19.0.10",
-    "@types/react-dom": "^19.0.4",
-    "babel-cli": "^6.26.0",
-    "husky": ">=6",
-    "lint-staged": ">=10",
-    "prettier": "^3.5.3",
-    "react": "^19.0.0",
-    "react-app-rewired": "^2.2.1",
-    "react-dom": "^19.0.0",
-    "react-scripts": "5.0.1",
-    "ts-loader": "^9.5.2",
-    "typescript": "^5.8.2",
-    "web-vitals": "^2.1.4"
-  },
-  "files": [
-    "dist",
-    "LICENSE",
-    "README.md"
-  ],
-  "jupyterlab": {
-    "extension": "src/plugin.ts",
-    "schemaDir": "src/schema",
-    "outputDir": "pret/ui/simple_dock/js-extension",
-    "webpackConfig": "./webpack.jupyter.js"
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
   },
   "browserslist": {
     "production": [
@@ -73,17 +25,5 @@
       "last 1 safari version"
     ]
   },
-  "prettier": {
-    "printWidth": 120,
-    "tabWidth": 4
-  },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
-  "lint-staged": {
-    "*.{js,css,md}": "prettier --write"
-  }
-}
+  "types": "index.d.ts"
+}

package/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types.js

@@ -1,6 +0,0 @@
-const LEFT = 0;
-const RIGHT = 1;
-const TOP = 2;
-const BOTTOM = 3;
-const TAB = 4;
-export {};