simple-window-manager API Documentation

new WindowManager (options, defaultOptions)

Name Type Description

options

object

optional

Name	Type	Default	Description
`parent`	HTMLElement	document.body	optional
`quiet`	boolean		optional suppress the simple-window-manager console message
`snap`	boolean \| SnapOptions		optional turn on edge and/or screen snapping
`keepInside`	boolean \| 'horizontal' \| 'vertical'	true	optional keep windows inside the parent in a certain direction

defaultOptions WindowOptions optional default WindowOptions used when createWindow is called

Example

var wm = new WindowManager();

wm.createWindow({ x: 20, y: 20, width: 200 })
wm.content.innerHTML = 'Hello there!'

Extends

EventEmitter

Classes

WindowManager

Members

bounds Bounds

overlay HTMLElement readonly

This is the bottom DOM element. Use this to set a wallpaper or attach elements underneath the windows

win HTMLElement readonly

This is the top-level DOM element

Methods

_createDom (parent) WindowManager.js:226

Name	Type	Description
`parent`	HTMLElement

attachWindow (win)Window WindowManager.js:92

Attach an existing window to the WindowManager Note: WindowManager.createWindow is the preferred way to create windows to ensure that all the defaultOptions are applied to the Window. If you use this function, then Window needs to be initialized with WindowOptions.

Name	Type	Description
`win`	Window

Returns:

Type	Description
Window	the window

closeAll () WindowManager.js:196

close all windows

createWindow (options)Window WindowManager.js:62

Create a window

Name Type Description

options

WindowOptions

optional

Name	Type	Description
`title`	string	optional
`x`	number	optional position
`y`	number	optional position
`modal`	boolean	optional
`id`	number \| *	optional if not provide, id will be assigned in order of creation (0, 1, 2...)

Returns:

Type	Description
Window	the created window

emit (event)Boolean inherited overrides index.js:166

Calls each of the listeners registered for a given event.

Name	Type	Description
`event`	String \| Symbol	The event name.

Returns:

Type	Description
Boolean	`true` if the event had listeners, else `false`.

eventNames ()Array inherited overrides index.js:104

Return an array listing the events for which the emitter has registered listeners.

Returns:

Type	Description
Array

listenerCount (event)Number inherited overrides index.js:150

Return the number of listeners listening to a given event.

Name	Type	Description
`event`	String \| Symbol	The event name.

Returns:

Type	Description
Number	The number of listeners.

listeners (event)Array inherited overrides index.js:129

Return the listeners registered for a given event.

Name	Type	Description
`event`	String \| Symbol	The event name.

Returns:

Type	Description
Array	The registered listeners.

load (data) WindowManager.js:180

restores the state of all the windows NOTE: this requires that the windows have the same id as when save() was called

Name	Type	Description
`data`	object	created by save()

once (event, fn, context)EventEmitter inherited overrides index.js:240

Add a one-time listener for a given event.

Name	Type	Default	Description
`event`	String \| Symbol		The event name.
`fn`	function		The listener function.
`context`	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

on (event, fn, context)EventEmitter inherited overrides index.js:227

Add a listener for a given event.

Name	Type	Default	Description
`event`	String \| Symbol		The event name.
`fn`	function		The listener function.
`context`	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

removeAllListeners (event)EventEmitter inherited overrides index.js:301

Remove all listeners, or those of the specified event.

Name	Type	Description
`event`	String \| Symbol	optional The event name.

Returns:

Type	Description
EventEmitter	`this`.

removeListener (event, fn, context, once)EventEmitter inherited overrides index.js:254

Remove the listeners of a given event.

Name	Type	Description
`event`	String \| Symbol	The event name.
`fn`	function	Only remove the listeners that match this function.
`context`	*	Only remove the listeners that have this context.
`once`	Boolean	Only remove one-time listeners.

Returns:

Type	Description
EventEmitter	`this`.

save ()object WindowManager.js:163

save the state of all the windows

Returns:

Type	Description
object	use this object in load() to restore the state of all windows

sendToBack (win) WindowManager.js:147

send window to back

Name	Type	Description
`win`	Window

sendToFront (win) WindowManager.js:131

send window to front

Name	Type	Description
`win`	Window

snap (options) WindowManager.js:115

enable edge and/or screen snapping

Name	Type	Description
`options`	SnapOptions