swing-ui 1.0.6 → 1.1.0

package/README.md

@@ -9,7 +9,7 @@ Build once, run it on Windows, Linux and macOS in your favorite JavaScript runti
 ![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+.
+`swing-ui` brings a new experience to Java Swing with enhanced components and a simple JavaScript API, allowing you to build 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.
 

package/SwingUI.js

@@ -72,7 +72,6 @@ export class SwingUI
 
 	/**
 	 * @internal
-	 * @private
 	 */
 	_msg = {
 		0: "Calling a function of a destroyed UI component",
@@ -167,7 +166,6 @@ export class SwingUI
 	/**
 	 * <b>NOTE:</b> Do not instantiate this class. It's already instantiated and assigned to a global variable `ui`.
 	 * @internal
-	 * @private
 	 */
 	constructor(module_dir, JBridge)
 	{
@@ -186,6 +184,9 @@ export class SwingUI
 		process.on("SIGHUP", this.exit.bind(this, 0, "SIGHUP"));
 	}
 
+	/**
+	 * @internal
+	 */
 	async InitGUIProcess()
 	{
 		if(this.runtime === "bun" || this.os === "darwin") this.#useWorkerThread = true;
@@ -775,6 +776,7 @@ export class SwingUI
 	 *
 	 * @example <h2>Sending queued messages without compressing:</h2>
 	 * ui.sendMessageQueue(false);
+	 * @internal
 	 */
 	sendMessageQueue(compress = true)
 	{
@@ -892,7 +894,7 @@ export class SwingUI
 	 */
 	get os()
 	{
-		let os = "";
+		let os;
 
 		if(this.runtime === "deno")
 		{
@@ -912,8 +914,64 @@ export class SwingUI
 	 * Getter property that returns an array of available UI look and feel IDs on your system. For example Windows OS can have a Windows look and feel that linux doesn't have. Use them to set the desired look and feel using ui.ui(id) method.
 	 *
 	 * @readonly
-	 * @see {@link SwingUI#ui|ui.ui(id)}
-	 * @type {string[]}
+	 * @see SwingUI#ui
+	 * @type {object[]}
+	 * @example <h2>Example of a returned array</h2>
+	 * [
+	 *   {
+	 *     "name": "Default",
+	 *     "id": "MetalLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "OS",
+	 *     "id": "WindowsLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "Metal",
+	 *     "dark": false,
+	 *     "id": "MetalLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "Nimbus",
+	 *     "dark": false,
+	 *     "id": "NimbusLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "CDE/Motif",
+	 *     "dark": false,
+	 *     "id": "MotifLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "Windows",
+	 *     "dark": false,
+	 *     "id": "WindowsLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "Windows Classic",
+	 *     "dark": false,
+	 *     "id": "WindowsClassicLookAndFeel"
+	 *   },
+	 *   {
+	 *     "name": "FlatLaf Light",
+	 *     "dark": false,
+	 *     "id": "FlatLightLaf"
+	 *   },
+	 *   {
+	 *     "name": "FlatLaf Dark",
+	 *     "dark": true,
+	 *     "id": "FlatDarkLaf"
+	 *   },
+	 *   {
+	 *     "name": "FlatLaf IntelliJ",
+	 *     "dark": false,
+	 *     "id": "FlatIntelliJLaf"
+	 *   },
+	 *   {
+	 *     "name": "FlatLaf Darcula",
+	 *     "dark": true,
+	 *     "id": "FlatDarculaLaf"
+	 *   }
+	 * ]
 	 */
 	get list()
 	{
@@ -982,7 +1040,7 @@ export class SwingUI
 	}
 
 	/**
-	 * Gets a GUI software license information stored in the package.json file of your project.
+	 * Gets a swing-ui software license information including the path on your file system where the license is stored.
 	 *
 	 * @readonly
 	 * @type {Object}
@@ -1211,7 +1269,9 @@ export class SwingUI
 	 * @return {string|SwingUI} When setting arguments, `this` instance of SwingUI is returned, otherwise current value is returned.
 	 * @throws Error When argument is invalid.
 	 * @see SwingUI#list
-	 * @example <h2>Setting FlatDarkLaf UI with all options</h2>
+	 * @example <h2>Setting System's UI Theme</h2>
+	 * ui.ui(ui.list.find(t => t.name === "OS").id);
+	 * @example <h2>Setting FlatDarkLaf UI theme with all options</h2>
 	 * ui.ui(
 	 *   "FlatDarkLaf",
 	 *   {
@@ -2630,5 +2690,59 @@ export class SwingUI
 		return this;
 	}
 
+	/**
+	 * Registers, unregisters and retrieves event handler for event emitted by changes to screens on the computer, such as connecting a screen, disconnecting a screen, or changes to screen resolution.
+	 *
+	 * @param {function(Object):any|null|undefined} [callback] - Function to handle the event, `null` to remove all handlers, or omit to retrieve an array of handlers.
+	 * @param {boolean} remove - Removed the callback from this event
+	 * @return {SwingUI|function[]} If called without parameters, an array of registered callbacks is returned; otherwise `this` instance of SwingUI class is returned.
+	 * @example <h2>Registering screens change event handler:</h2>
+	 * ui.onScreensChange(e => {console.log(e.screens});
+	 * @see ui#screens
+	 */
+	onScreensChange(callback = undefined, remove = false)
+	{
+		const name = "onScreensChange";
+
+		// return callbacks
+		if(callback === undefined) return Array.isArray(this.callback[name]) ? [...this.callback[name]] : [];
+
+		// remove callback
+		if(remove === true || callback === null)
+		{
+			if(!Array.isArray(this.callback[name])) return this;
+
+			if(callback === null)
+			{
+				this.callback[name].length = 0;
+			}
+			else
+			{
+				this.callback[name] = this.callback[name].filter(l => l !== callback);
+			}
+
+			if(this.callback[name].length === 0)
+			{
+				delete this.callback[name]; // delete array
+				this.sendToGUI({system: name, remove: true}); // notify GUI
+			}
+		}
+		// add callback
+		else
+		{
+			if(typeof callback !== "function") throw new Error(`Invalid argument for callback function. Must be a "function" type.`);
+
+			if(!Array.isArray(this.callback[name]))
+			{
+				this.callback[name] = []; // create array
+				this.sendToGUI({system: name, remove: false}); // notify GUI
+			}
+
+			this.callback[name].push(callback); // add callback (don't bind to this here, do it at call)
+		}
+
+		return this;
+	}
+
 	//endregion
 }

package/classes/Arc.js

@@ -96,7 +96,7 @@ export class Arc extends Shape
 		}
 		else
 		{
-			return {width: this._size.width, height: this._size.height};
+			return {width: this._hole_size.width, height: this._hole_size.height};
 		}
 	}
 	

package/classes/ComboBox.js

@@ -31,20 +31,20 @@ export class ComboBox extends TextComponent
 	 * @see ListItem
 	 * @example
 	 * // Creating combo box, then adding each item separately.
-	 * const combo1 = new ComboBox().add("Item 1").add(45).add({text: "Item 2", font:{bolt:true}});
+	 * const combo1 = new ComboBox().add("Item 1").add(45).add({text: "Item 2", font:{bold:true}});
 	 *
 	 * // Creating combo box, then adding items as an array.
 	 * const combo2 = new ComboBox().items([
 	 *     "Item 1",
 	 *     45,
-	 *     {text: "Item 3", font:{bolt:true}}
+	 *     {text: "Item 3", font:{bold:true}}
 	 * ]);
 	 *
 	 * // Creating combo box with items as a string and object. Items can be a mix of strings and objects.
 	 * const combo3 = new ComboBox([
 	 *      "Item 1",
 	 *      45,
-	 *      {text: "Item 3", font:{bolt:true}}
+	 *      {text: "Item 3", font:{bold:true}}
 	 * ]);
 	 */
 	constructor(...args) // accepts an optional parameter, array of string for list items

package/classes/ComponentContainer.js

@@ -13,7 +13,13 @@ export class ComponentContainer extends UIComponent
 	#_children = []; // child components of this component
 	#descriptorObject = null;
 
+	/**
+	 * @internal
+	 */
 	static preInitProperties = ["position", "size", "innerSize"];
+	/**
+	 * @internal
+	 */
 	static postInitProperties = ["defaultButton", "state", "visible"]; // state must be applied after all children apply anchor property
 
 	/**
@@ -129,7 +135,7 @@ export class ComponentContainer extends UIComponent
 	 * In loops `for..in`, `for..of` or `component.children.forEach((c, i)=>{...})` it's accessed only once, so you are looping through the same array.
 	 *
 	 * @readonly
-	 * @type {Object[]}
+	 * @type {UIComponent[]}
 	 * @example <h2>Looping through Window's components</h2>
 	 * // method 1
 	 * for(child of window.children)
@@ -181,7 +187,7 @@ export class ComponentContainer extends UIComponent
 	/**
 	 * Gets or sets the index of a child component within this container. Setting new index changes z-order of the component.
 	 *
-	 * @param {Object} child - Child component
+	 * @param {UIComponent} child - Child component
 	 * @param {number} [new_index] - The new index to assign to the child. Moves the component in z-order.
 	 * @return {this|null|number} If `new_index` is provided, returns `this` component. If the child is not found in this container, returns `null`. Otherwise, returns the child's current z-index.
 	 */
@@ -213,7 +219,7 @@ export class ComponentContainer extends UIComponent
 	/**
 	 * Adds a child component to this container component.
 	 *
-	 * @param {object} component - UI Component that can be a child of this component.
+	 * @param {UIComponent} component - UI Component that can be a child of this component.
 	 * @param {number|object} [data_or_index] - Argument to pass some extra data (such as Tab Name to add Panel to Tabs), or index at which to insert the child. By default component is added to the end.
 	 * @returns {this} Returns an instance of `this` component for chaining.
 	 * @see UIComponent#addTo
@@ -319,7 +325,7 @@ export class ComponentContainer extends UIComponent
 	/**
 	 * Removes component's child by child object or child index.
 	 *
-	 * @param {object|number} child_or_index - Child component object or index of the child.
+	 * @param {UIComponent|number} child_or_index - Child component object or index of the child.
 	 * @param {boolean} [recursive=false] - Boolean indicates if all descendents of this child should also be removed.
 	 * @returns {UIComponent|null} The removed child component, or `null` if there is no child at specified index.
 	 */
@@ -366,11 +372,11 @@ export class ComponentContainer extends UIComponent
 	 * @param {boolean} [recursive=false] - Set to true to also destroy all of its descendants recursively
 	 * @returns {void}
 	 */
-	destroy(...args)
+	destroy(recursive=false)
 	{
 		if(this.destroyed) return;
 
-		const recursive = (args.length > 0 && args[0] === true);
+		recursive = (recursive === true);
 
 		// remove all child components, from last to first (IMPORTANT)
 		for(let i = this.#_children.length - 1; i >= 0; i--)
@@ -389,13 +395,13 @@ export class ComponentContainer extends UIComponent
 			{error(ex);}
 		}
 
-		super.destroy(...args);
+		super.destroy(recursive);
 	}
 
 	/**
 	 * Checks if passed component is a descendant of this container component.
 	 *
-	 * @param descendant - Child component to check.
+	 * @param {UIComponent} descendant - Child component to check.
 	 * @returns {boolean} If the descendant component is inside of this component.
 	 * @throws {TypeError} When passed argument is not an instance of UIComponent.
 	 * @see UIComponent#insideOf
@@ -821,7 +827,7 @@ export class ComponentContainer extends UIComponent
 		{
 			if(!(event in component))
 			{
-				error(`${class_name}.${event} is not valid event function for ${class_name} in your .ui.json file:\n\n${common.ui_file}`, false);
+				error(`${class_name}.${event} is not a valid event function for ${class_name} in your .ui.json file:\n\n${common.ui_file}`, false);
 				continue;
 			}
 

package/classes/ContextMenu.js

@@ -103,7 +103,7 @@ export class ContextMenu extends ComponentContainer
 	/**
 	 * Adds this ContextMenu to a specified parent component.
 	 *
-	 * @param {object} parent - A valid component that accepts ContextMenu. `parent` must be derived from UIComponent.
+	 * @param {ComponentContainer} parent - A valid component that accepts ContextMenu. `parent` must be derived from UIComponent.
 	 * @return {ContextMenu} Returns an instance of `this` object.
 	 */
 	addTo(parent, ...args)

package/classes/List.js

@@ -46,20 +46,20 @@ export class List extends ScrollableComponent
 	 * @param {Array<string|number|ListItem>} [items] - Items as an Array of ListItem formatted objects, strings or numbers. Can be a mix of these types.
 	 * @example
 	 * // Creating combo box, then adding each item separately.
-	 * const combo1 = new ComboBox().add("Item 1").add(45).add({text: "Item 2", font:{bolt:true}});
+	 * const combo1 = new ComboBox().add("Item 1").add(45).add({text: "Item 2", font:{bold:true}});
 	 *
 	 * // Creating combo box, then adding items as an array.
 	 * const combo2 = new ComboBox().items([
 	 *     "Item 1",
 	 *     45,
-	 *     {text: "Item 2", font:{bolt:true}}
+	 *     {text: "Item 2", font:{bold:true}}
 	 * ]);
 	 *
 	 * // Creating combo box with items as a string and object. Items can be a mix of strings and objects.
 	 * const combo3 = new ComboBox([
 	 *      "Item 1",
 	 *      45,
-	 *      {text: "Item 2", font:{bolt:true}}
+	 *      {text: "Item 2", font:{bold:true}}
 	 * ]);
 	 */
 	constructor(...args)

package/classes/RadioButton.js

@@ -2,9 +2,10 @@
 import {UIComponent} from "./UIComponent.js";
 
 /**
- * RadioButton is a component used to select of multiple option by clicking on it.
- * Multiple RadioButton components must be grouped for selection to work.
- * To group them pick one main RadioButton and group other RadioButton components with it.
+ * RadioButton is a component used to select one of multiple option by clicking on it.
+ *
+ * Multiple RadioButton components must be grouped for selection to work. To group them pick one main RadioButton and group other RadioButton components with it.
+ *
  * For example if you have three RadioButton components, you must group second component with first one, then third component with any component that is already grouped (first or second).
  * Then to detect selection changes add onChange(e => {console.log(e.value);}) to only one of the grouped RadioButton components, and e.value will be the value of currently selected RadioButton.
  * @class

package/classes/RadioButtonMenuItem.js

@@ -2,13 +2,13 @@
 import {MenuItem} from "./MenuItem.js";
 
 /**
- * Radio button menu item UI component that extends MenuItem class.
+ * Radio button menu item UI component.
+ *
+ * RadioButtonMenuItem is a component used to select one of multiple option by clicking on it. Multiple RadioButtonMenuItem components must be grouped for selection to work as expected. To group them pick one main RadioButtonMenuItem and group other RadioButtonMenuItem with it.
  *
- * RadioButton is a component used to select of multiple option by clicking on it.
- * Multiple RadioButton components must be grouped for selection to work as expected.
- * To group them pick one main RadioButtonMenuItem and group other RadioButtonMenuItem with it.
  * For example if you have three RadioButtonMenuItem components that you want to group, you must group second component with first one, then third component with any component that is already grouped (first or second).
- * Then to detect selection changes add onChange(e => {console.log(e.value);}) to only one of the grouped RadioButton components, and e.value will be the value of currently selected RadioButton.
+ *
+ * Then to detect selection changes add onChange(e => {console.log(e.value);}) to only one of the grouped RadioButton components, and e.value will be the value of currently selected RadioButton in the group.
  * See example below.
  *
  * @class

package/classes/ScrollPane.js

@@ -38,7 +38,7 @@ class ScrollPane extends ComponentContainer
 	/**
 	 * Adds a child component to this container component.
 	 *
-	 * @param {Object} component - UI Component that can be a child of this component.
+	 * @param {UIComponent} component - UI Component that can be a child of this component.
 	 * @returns {this} Returns an instance of `this` component.
 	 */
 	addChild(component, ...data)

package/classes/Table.js

@@ -740,8 +740,6 @@ export class Table extends ScrollableComponent
 	 */
 	editingCell(...args)
 	{
-		let msg = {control: this.id};
-
 		if(args.length > 0)
 		{
 			const cell = args[0] == null ? null : (typeof args[0] === "object") ? args[0] : {row: parseInt(args[0]), col: parseInt(args[1])};
@@ -753,6 +751,36 @@ export class Table extends ScrollableComponent
 			return this.property("editingCell", [])
 		}
 	}
+
+	/**
+	 * Sets or gets how many quick mouse clicks on editable cells are required to change the cell to editing mode.
+	 *
+	 * @param {number} [clicks] - Amount of clicks: 1, 2, or 3. Default is 2 (double-click).
+	 * @return {number|Table} Returns the current value if no parameters are provided; otherwise, and instance of `this` Table is returned.
+	 */
+	clicksToEdit(...args)
+	{
+		if(args.length > 0)
+		{
+			// enforce int
+			args[0] = Math.max(1, Number.parseInt(args[0]));
+			if(!Number.isSafeInteger(args[0])) throw new TypeError(`Invalid Table.clickToEdit() argument. A positive integer is required.`);
+		}
+		return this.property("clicksToEdit", args);
+	}
+
+	/**
+	 * Sets or gets whether to allow row selection with a click of a right mouse button.
+	 *
+	 * @param {boolean} [enable] - Boolean value that enables or disables right-click row selection.
+	 * @return {boolean|List} Returns `this` component instance if at least one argument is provided, otherwise returns current value.
+	 * @since 1.1.0
+	 */
+	rightClickSelect(...args)
+	{
+		if(args.length > 0) args[0] = (args[0] === true); // ensure boolean
+		return this.property("rightClickSelect", arguments);
+	}
 	
 	/**
 	 * Sets or gets whether sorting can be toggled to unsorted state.
@@ -886,23 +914,6 @@ export class Table extends ScrollableComponent
 		return ui.sendToGUI({control: this.id, get: "cellAt", data: {x: x, y: y}});
 	}
 	
-	/**
-	 * Sets or gets how many quick mouse clicks on editable cells are required to change the cell to editing mode.
-	 *
-	 * @param {number} [clicks] - Amount of clicks: 1, 2, or 3. Default is 2 (double-click).
-	 * @return {number|Table} Returns the current value if no parameters are provided; otherwise, and instance of `this` Table is returned.
-	 */
-	clicksToEdit(...args)
-	{
-		if(args.length > 0)
-		{
-			// enforce int
-			args[0] = Math.max(1, Number.parseInt(args[0]));
-			if(!Number.isSafeInteger(args[0])) throw new TypeError(`Invalid Table.clickToEdit() argument. A positive integer is required.`);
-		}
-		return this.property("clicksToEdit", args);
-	}
-	
 	//endregion
 	
 	//region Events

package/classes/ToolBar.js

@@ -2,7 +2,7 @@
 import {ComponentContainer} from "./ComponentContainer.js";
 
 /**
- * A toolbar component that is usually used at the top of window and can hold {@link Label}, {@link Button}, {@link TextField}, {@link ComboBox}, and a {@link Separator} to display useful tools for a user.
+ * A toolbar component that is usually used at the top of window and can hold {@link Label}, {@link Button}, {@link TextField}, {@link PasswordField}, {@link Spinner}, {@link ComboBox}, {@link CheckBox}, {@link RadioButton} and a {@link Separator} to display useful tools for a user.
  *
  * Toolbar can be draggable and can be detached and displayed in a separate dedicated window. It can also be in horizontal (default) and vertical orientation.
  *
@@ -57,7 +57,7 @@ export class ToolBar extends ComponentContainer
 	{
 		return this.property("orientation", args);
 	}
-	
+
 	/**
 	 * Sets or gets a padding size between edge of the component and items inside it, and spacing between items.
 	 *

package/classes/Tree.js

@@ -491,6 +491,18 @@ export class Tree extends ScrollableComponent
 		return this.property("clicksToEdit", args.length > 0 ? [parseInt(args[0])] : args);
 	}
 
+	/**
+	 * Sets or gets whether to allow selecting list items with a click of a right mouse button.
+	 * @param {boolean} [enable] - Boolean value that enables or disables right-click item selection.
+	 * @return {boolean|List} Returns `this` component instance if at least one argument is provided, otherwise returns current value.
+	 * @since 1.1.0
+	 */
+	rightClickSelect(...args)
+	{
+		if(args.length > 0) args[0] = (args[0] === true); // ensure boolean
+		return this.property("rightClickSelect", arguments);
+	}
+
 	/**
 	 * Sets or gets whether Tree nodes' text can be edited by user.
 	 *

package/classes/UIComponent.js

@@ -399,7 +399,7 @@ class UIComponent
 	 * @param {boolean} [recursive=false] - Set to true to also destroy all of its descendants recursively
 	 * @returns {void}
 	 */
-	destroy(...args)
+	destroy(recursive=false)
 	{
 		if(this.destroyed) return;
 

package/classes/Window.js

@@ -26,7 +26,8 @@ class Window extends ShapeContainer
 	#owner = null; // used only for modal window
 	#prop = {
 		closeOperation: Window.CloseOperation.Exit,
-		innerOffset: null
+		innerOffset: null,
+		toolBar:{}
 	};
 
 	/**
@@ -604,6 +605,46 @@ class Window extends ShapeContainer
 		return this.property("opacity", args);
 	}
 
+	/**
+	 * Sets a ToolBar to one of locations: `top`, `right`, `bottom` and `left`, or gets a ToolBar at a specified location.
+	 *
+	 * @param {string} dockLocation - One of: `top`, `right`, `bottom` and `left`.
+	 * @param {ToolBar} [toolbar] - ToolBar to set to specified location. Set `null` to remove the toolbar from that location. Omit to get the toolbar already in that location.
+	 * @returns {ToolBar|null|Window} If only location is specified, a {@link ToolBar} or `null` is returned. When `toolbar` argument is passed, an instance of `this` Window is returned.
+	 * @since 1.0.8
+	 */
+	toolBar(dockLocation, toolbar = undefined)
+	{
+		if(typeof dockLocation !== "string")
+		{
+			return null;
+		}
+		else if(toolbar === undefined) // gets toolbar
+		{
+			const id = ui.sendToGUI({control: this.id, get: "toolBar", data: dockLocation});
+
+			return id === -1 ? null : UIComponent.get(id) ?? null; // in case it was destroyed already
+		}
+		else if(toolbar === null)
+		{
+			if(this.#prop.toolBar[dockLocation] instanceof ToolBar)
+			{
+				this.property("toolBar", [{id: null, location: dockLocation}])
+				delete this.#prop.toolBar[dockLocation];
+			}
+		}
+		if(toolbar instanceof ToolBar) // sets toolbar
+		{
+			if("top right bottom left".includes(dockLocation))
+			{
+				if(this.#prop.toolBar[dockLocation] instanceof ToolBar) this.property("toolBar", [{id: null, location: dockLocation}])
+				this.#prop.toolBar[dockLocation] = toolbar;
+
+				this.property("toolBar", [{id: toolbar.id, location: dockLocation}])
+			}
+		}
+		return this;
+	}
 }
 
 export {Window};

package/functions.js

@@ -119,7 +119,7 @@ export function stringify(variable)
 }
 
 /**
- * Displays a dialog window with a specified error message and an error icon.
+ * Displays a dialog window with a specified message and optional icon.
  *
  * @param {string} message - A message to be displayed in the dialog window
  * @param {string} [title="Message"] - Dialog window title bar text
@@ -212,10 +212,10 @@ export function confirm(message, window = null)
  *
  * @param {string} message - String message to user. It can be plain text or HTML.
  * @param {string} [title=""] - Dialog window title shown in the title bar of the window
- * @param {string[]} [buttons=["OK","Cancel"]] - An Array of button names. Indicate a default button by surrounding the text with square brackets like so: "[Cancel]"
+ * @param {string[]} [buttons=["[OK]","Cancel"]] - An array of button names. Indicate a default button by surrounding the text with square brackets like so: "[OK]"
  * @param {MessageIcon|string} [icon=null] - One of MessageIcon icons, or an absolute path to an image from a file system.
  * @param {Window} [window=null] - Owner window that will be overlaid by this dialog window. If omitted, last created visible Window that's not PopUp will be used.
- * @return {number|undefined} Returns a zero-based number of a clicked button, or `null` if the dialog window was closed without clicking provided buttons.
+ * @return {number|null} Returns a zero-based number of a clicked button, or `null` if the dialog window was closed without clicking provided buttons.
  * @global
  * @example <h2>Usage example</h2>
  * let response = dialog("Are you ready?", "Confirm readiness", ["Yes", "No", "[Maybe]"], MessageIcon.Question, window);
@@ -229,7 +229,7 @@ export function confirm(message, window = null)
  * @example <h2>Using custom image</h2>
  * let response = dialog("Is this you?", "Question #5", ["Yes","[No]"], "C://User/John/profile_icon.jpg", window);
  */
-export function dialog(message, title = "", buttons = ["OK", "Cancel"], icon = null, window = null)
+export function dialog(message, title = "", buttons = ["[OK]", "Cancel"], icon = null, window = null)
 {
 	// find first visible window
 	if(window == null)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "swing-ui",
-	"version": "1.0.6",
+	"version": "1.1.0",
 	"description": "Cross-platform Graphic User Interface for Node.js, Bun and Deno 2+",
 	"main": "index.js",
 	"scripts": {