swing-ui 0.1.25 → 1.0.1

package/LICENSE

@@ -1,13 +1,14 @@
 Custom License Agreement
 
-Copyright (c) Dmitriy Kulikovskiy
+Copyright (c) eSoftie LLC
 
-1. You are allowed to use the code for personal purposes. For commercial license contact the author.
-2. You are not allowed to modify, distribute, or sell the code, in whole or in part.
+1. You are allowed to use the module for Personal use, or Commercial use if Commercial license is obtained from swing-ui.com
+2. You are not allowed to modify, decompile, distribute, or sell the code, in whole or in part.
 3. For more details contact support@esoftie.com
 
 Permission to use this software for personal use hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
+copyright notice and this permission notice appear in all copies. Complete terms of use and privacy policy
+is provided at swing-ui.com and may change without notice.
 
 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

package/README.md

@@ -1,7 +1,144 @@
-# NOTE: This module is not fully published  yet. I am in the process of publishing it. Check official site to see the progress **https://swing-ui.com**.
-
-
-
-## So...
-
-Check back later to be the first try it out. I love this UI and I am sure you will find it useful as well.
+# `swing-ui` GUI Module
+
+**Build real cross-platform desktop apps in JavaScript — no Electron, no Chromium, no browser, no HTML/CSS**, no React/Angular/Svelte/Vue. **No back-end / front-end mess**.
+
+Build once, run it on Windows, Linux and macOS in your favorite JavaScript runtime: Node.js, Bun, or Deno 2+.
+
+[![npm version](https://img.shields.io/npm/v/swing-ui.svg)](https://www.npmjs.com/package/swing-ui)
+![Node | Bun | Deno](https://img.shields.io/badge/runtime-Node.js%20%7C%20Bun%20%7C%20Deno%202%2B-brightgreen)
+![Windows | macOS | Linux](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue)
+[![npm license](https://img.shields.io/npm/l/swing-ui.svg)](https://www.npmjs.com/package/swing-ui)
+
+`swing-ui` wraps and upgrades the full Java Swing library so you can write native-looking, cross-platform desktop applications entirely in JavaScript using the JS runtime you already know: Node.js, Bun or Deno 2+.
+
+You only write JavaScript and the GUI gets built, or better yet, use our [Visual GUI Designer](https://swing-ui.com/visual-gui-designer/) to skip coding at all.
+
+Try it in your project: `npm install swing-ui`.
+
+For quick onboarding check out swing-ui.com [Getting Started](https://swing-ui.com/installation/) guide and [API reference](https://swing-ui.com/jsdocs.php).
+
+---
+
+> Finally, JavaScript is no longer for web browser and server back end. Now its for desktop apps too.
+
+## Problems with building JavaScript desktop apps without `swing-ui`
+ 
+If you've shipped a desktop app in JS before, you've probably lived one of these:
+
+- **Electron works, but it's heavy, require HTML, CSS, ....** Every app ships its own copy of Chromium and Node, so installers balloon past 100–150 MB and even simple apps chew through RAM before you've drawn a single window.
+- **The "lightweight" alternatives mean leaving JavaScript.** Native performance and a small footprint usually mean learning Qt, WinForms, or raw Swing/AWT in a completely different language and ecosystem.
+- **HTML/CSS UIs never quite feel native.** Buttons, menus, and dialogs built in a webview look and behave like a webpage wearing a desktop costume, not a real OS application.
+- **Back-end/front-end confusion and management makes coding horrible.** Now it's just one JavaScript code like it should be.
+- **Asynchronous request calls to UI components from main application logic are messy.** `swing-ui` provides a synchronous deterministic code execution, so that when you request a text from a component in your main application logic code, you can use the returned text in your next line of code without using `await`, Promise and a callback function.
+
+`swing-ui` removes those issues. You get a **real native OS windows and UI components from enhanced Java Swing library** and you don't have to write a single line of Java code, HTML or CSS. Write your UI in plain JavaScript, or simply design the UI in our free **[swing-ui Visual GUI Designer](https://swing-ui.com/visual-gui-designer/)**.
+
+![swing-ui under the hood](https://swing-ui.com/wp-content/uploads/2026/04/3D-swing-ui-stack-244x300.png)
+
+---
+
+## Why developers love `swing-ui` GUI module
+
+- **No browser engine, no markup.** No Chromium bundled into your build, no HTML, no CSS — just JavaScript, or the visual GUI Designer if you'd rather not hand-position pixels.
+- **It's just JavaScript, with a chainable API.** Every component returns itself, so building UI reads like jQuery, not like fighting a framework:
+
+  ```js
+  const saveButton = new Button("Save").position(15, 50).size(100, 30)
+    .addTo(window)
+    .onAction(e => save());
+  ```
+
+- **[JavaScript API](https://swing-ui.com/jsdocs.php) is super easy, intuitive, and well documented**. Quick onboarding docs and API reference is at [swing-ui.com](https://swing-ui.com).
+- **Simple synchronous code execution**. No need to use `await` or callback function to get Ui component property or value.
+- **For your convenience complex low level stuff is highly simplified without much compromise**. For example features like drag-and-drop, undo/redo, clipboard management, table manipulation, images support and much more.
+- **Looks native, not just close.** swing-ui can opt into your OS's system look-and-feel, so windows and controls take on native Windows, macOS, or Linux styling instead of a generic default theme.
+- **The full Java Swing component library, from JS.** Tables with sorting, filtering, column reordering and hiding; trees, tabs, and split views; rich clipboard and drag-and-drop support — including MIME types, both within your app and to/from other applications; full icon and image support across JPG, PNG, GIF, BMP, ICO, TIFF, HEIC, WEBP, AVIF; and deep event handling for actions, mouse, scrolling, resizing, and more.
+- **Runs on the runtime you already picked.** First-class support for **Node.js, Bun, and Deno 2+** — same API, same imports.
+- **Synchronous where it should be.** GUI calls, file reads/writes, clipboard access — no unnecessary `await` and callbacks for things that don't need it.
+- **One honest dependency.** swing-ui needs a Java 11+ JDK on the system PATH to power the native rendering — the whole trade-off for skipping Chromium. It's light enough to run on a $5 Raspberry Pi Zero, just slower than on a desktop.
+- **Multiple UI themes available.** In addition to few themes build into Java, like `metal` or system look-and-feel, `swing-ui` includes beautiful `FlatLaf` themes (light and dark) from https://www.formdev.com/flatlaf/.
+- **AI already writes apps with `swing-ui` GUI using our pre-made skill and GUI definition file schema**.
+
+---
+
+## Quick look
+
+```bash
+npm install swing-ui
+```
+
+> Install it locally in each project — not with `-g`.
+
+```js
+import "swing-ui";
+
+class HelloApp extends Window {
+  constructor() {
+    super("swing-ui Demo");
+    this.innerSize(360, 160).position(200, 200).closeOperation(Window.CloseOperation.Exit);
+
+    new Label("What's your name?").position(20, 20).addTo(this);
+    const name = new TextField("type name here").size(300, 28).position(20, 45).addTo(this);
+
+    new Button("Greet me").position(20, 85).addTo(this)
+      .onAction(e => alert(`Hello, ${name.text()}!`));
+
+    this.show();
+  }
+}
+
+globalThis.HelloApp = new HelloApp();
+```
+
+Run it with `node index.js` (or `bun index.js` / `deno run index.js`) and you get a real, resizable, native OS window — not a browser tab.
+
+That's just a taste. Tables, trees, tabs, menus, system tray icons, custom drawing, and the full component API are all covered in the docs.
+
+---
+
+## See it in action
+
+- A [notes app built entirely with swing-ui](https://swing-ui.com/wp-content/uploads/2024/09/swing-ui-based-notes-application.jpg) — a real simple example of what you can ship
+- Our [Visual GUI Designer](https://swing-ui.com/wp-content/uploads/2026/04/GUI-Designer-1.png) was build entirely in JavaScript with `swing-ui` GUI module.
+---
+
+## What people build with it
+
+- Internal tools
+- Admin dashboards
+- Data-entry apps
+- File and asset managers
+- Monitoring utilities
+- Small line-of-business apps
+- Simple graphical games using shapes API
+- Vector drawing apps
+- Industrial control software
+- CNC software
+- Financial software with graphical graphs and charts
+- and much more...
+
+Anywhere you want a real desktop app without the weight of a browser runtime, and without leaving JavaScript to get it. With thousands or JavaScript modules now almost anything is possible in JavaScript.
+
+---
+
+## Requirements
+
+- Windows, Linux, or macOS
+- Node.js 18+, Bun 1.1+, or Deno 2+
+- Java 11+ JDK, with `java` available on the system `PATH`
+- 1 GHz processor and 500 MB RAM or more - light enough to even run on a $5 Raspberry Pi Zero
+- ECMAScript Module (ESM) mode only (`"type": "module"` in `package.json`)
+
+---
+
+## Docs
+
+This README is just the pitch. Everything else lives at **[swing-ui.com](https://swing-ui.com)**:
+
+- Quick onboarding guide — go from `npm install` to `swing-ui` expert in no time
+- Full JavaScript API reference, class by class
+- Coding style and patterns explained, theming, Visual GUI Designer, and UI-definition-file guides
+- More examples
+
+Found a bug? [Report it here](https://swing-ui.com/report-bug/) — every report gets reviewed and helps to make `swing-ui` even better.
+