The following example pages are good showcases for the Uize.Dom.VirtualEvents.Remain module...

Virtual DOM Events - A demonstration of various virtual DOM events, such as mouseRest, mouseRemainOver, mouseRemainDown, remainFocused, ctrlClick, shiftClick, and more.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Dom.VirtualEvents.Remain module...

SEARCH

The Uize.Dom.VirtualEvents.Remain module defines the Uize.Dom.VirtualEvents.Remain package under the Uize.Dom.VirtualEvents namespace.

1.2.1. Features Introduced in This Module

1.2.2. Features Overridden in This Module

1.2.3. Features Inherited From Other Modules

1.2.4. Modules Directly Under This Namespace

1.2.5. Unit Tests

The Uize.Dom.VirtualEvents.Remain module provides the following static methods for making remain-in-state virtual DOM events...

	Uize.Dom.VirtualEvents.Remain.keyRemainDown
	Uize.Dom.VirtualEvents.Remain.keyRemainUp
	Uize.Dom.VirtualEvents.Remain.mouseRemainDown
	Uize.Dom.VirtualEvents.Remain.mouseRemainOut
	Uize.Dom.VirtualEvents.Remain.mouseRemainOver
	Uize.Dom.VirtualEvents.Remain.mouseRemainUp
	Uize.Dom.VirtualEvents.Remain.mouseRest
	Uize.Dom.VirtualEvents.Remain.remainBlurred
	Uize.Dom.VirtualEvents.Remain.remainFocused

The Uize.Dom.VirtualEvents.Remain module registers the following event names for remain-in-state registered virtual DOM events...

	keyRemainDown
	keyRemainUp
	mouseRemainDown
	mouseRemainOut
	mouseRemainOver
	mouseRemainUp
	mouseRest
	remainBlurred
	remainFocused

Returns a virtual DOM event object, for an event that is fired when the user presses down on a key on the keyboard for a focused node that supports key events, and then holds down that key for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.keyRemainDown (durationMsINT);

When a handler is wired for this virtual DOM event on a node that supports key events, a timer is started when the user presses down on a key on the keyboard while that node is focused. If the user holds down the key for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user releases the key before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.keyRemainDown ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name keyRemainDown
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when the user releases a key on the keyboard for a focused node that supports key events, and then doesn't press down on a key again for that node for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.keyRemainUp (durationMsINT);

When a handler is wired for this virtual DOM event on a node that supports key events, a timer is started when the user releases a key on the keyboard while that node is focused. If the user doesn't press down on a key again while that node is focused, for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user does press down again on a key before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.keyRemainUp ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name keyRemainUp
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

For advanced users, returns a virtual DOM event maker function, for a remain-in-state virtual DOM event that is triggered by the specified trigger events and that is canceled by the specified cancel events.

SYNTAX

eventMakerFUNC = Uize.Dom.VirtualEvents.Remain.makeRemainInStateEventMaker (
  eventNameSTR,
  defaultDurationMsINT,
  timerTriggerEventSTRorEventsARRAY,
  timerCancelEventSTRorEventsARRAY,
  triggerEventsResetTimerBOOL,        // optional
  allowRefireBOOL                     // optional
);

3.3.1. eventNameSTR

3.3.2. defaultDurationMsINT

3.3.3. timerTriggerEventSTRorEventsARRAY

3.3.4. timerCancelEventSTRorEventsARRAY

3.3.5. triggerEventsResetTimerBOOL

3.3.6. allowRefireBOOL

EXAMPLE

Uize.Dom.VirtualEvents.Remain.mouseRest = Uize.Dom.VirtualEvents.Remain.makeRemainInStateEventMaker (
  'mouseRest',                // event name is "mouseRest"
  500,                        // default duration of 500 milliseconds
  ['mouseover','mousemove'],  // remain-in-state timer trigger events
  ['mouseout','mousedown'],   // remain-in-state timer cancel events
  true,                       // trigger events do reset timer
  false                       // don't allow refiring until cancel occurs again
);

The above call to the Uize.Dom.VirtualEvents.Remain.mouseRest method would manufacture the mouseRest virtual DOM event that is offered in this module. This method is in fact used to make all of the remain-in-state virtual DOM events that are offered in the Uize.Dom.VirtualEvents.Remain module. For an exhaustive look at how this method can be used to manufacture virtual DOM event maker functions, take a look at the source code for this module.

NOTES

this method is intended for advanced users wishing to create their own unique remain-in-state virtual DOM events, beyond those that are supplied as built-in events in this module

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a user mouses down on a node and doesn't mouse up from that node or mouse out of it for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainDown (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the user mouses down on the node. If the user doesn't mouse up from the node or mouse out of it for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user does mouse up from the node, or if the user mouses out of the node before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainDown ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name mouseRemainDown
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a user mouses out of a node and doesn't mouse over that node again for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainOut (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the user mouses out of the node. If the user doesn't mouse over the node again for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user does mouse over the node again before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainOut ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name mouseRemainOut
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a user mouses over a node and doesn't mouse out of that node or mouse down on it for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainOver (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the user mouses over the node. If the user doesn't mouse out of the node or mouse down on it for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user does mouse out of the node, or if the user mouses down on the node before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainOver ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name mouseRemainOver
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a user mouses up on a node and doesn't mouse down again on that node for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainUp (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the user mouses up on the node. If the user doesn't mouse down again on the node for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the user does mouse down again on the node before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainUp ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name mouseRemainUp
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired once the user has rested the mouse over a node (and doesn't mouse out of that node or mouse down on it) for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRest (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the user mouses over the node. If the user rests the mouse and doesn't mouse out of the node or mouse down on it for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If the user moves the mouse but stays over the node, then the timer is reset and the handler may still be executed if the user once again rests the mouse over the node for the required amount of time. If the user moves the mouse out of the node, or if the user mouses down on the node before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.mouseRemainOut ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

Because the mouserest event is a virtual DOM event, there is no dedicated browser event object that can be supplied to a handler for this event. What is supplied to an event handler is a copy of the last mouseover or mousemove browser event (likely the latter), allowing the handler to at least have access to coordinates that reflect the mouse position when the mouserest event is fired.

NOTES

	this virtual DOM event maker is registered with the name mouseRest
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a node loses focus and remains blurred / unfocused for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.remainBlurred (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the node loses focus. If the node remains blurred / unfocused for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the node regains focus before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.remainBlurred ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name remainBlurred
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

Returns a virtual DOM event object, for an event that is fired when a node stays focused for a specified amount of time.

SYNTAX

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.remainFocused (durationMsINT);

When a handler is wired for this virtual DOM event on a node, a timer is started when the node becomes focused. If the node remains focused for the amount of time specified by the durationMsINT parameter, then the handler wired for this event will be executed. If, however, the node loses focus before the required amount of time has elapsed, then the timer will be canceled and the handler will not be executed.

VARIATION

virtualDomEventOBJ = Uize.Dom.VirtualEvents.Remain.remainFocused ();

When no durationMsINT parameter is specified, then the value for this parameter is defaulted to 500 (half a second).

NOTES

	this virtual DOM event maker is registered with the name remainFocused
	see related remain-in-state virtual DOM event static methods

IMPLEMENTATION INFO

this feature was introduced in this module

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.keyRemainDown static method.

SYNTAX

keyRemainDown()
keyRemainDown(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','keyRemainDown(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.keyRemainUp static method.

SYNTAX

keyRemainUp()
keyRemainUp(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','keyRemainUp(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.mouseRemainDown static method.

SYNTAX

mouseRemainDown()
mouseRemainDown(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','mouseRemainDown(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.mouseRemainOut static method.

SYNTAX

mouseRemainOut()
mouseRemainOut(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','mouseRemainOut(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.mouseRemainOver static method.

SYNTAX

mouseRemainOver()
mouseRemainOver(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','mouseRemainOver(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.mouseRemainUp static method.

SYNTAX

mouseRemainUp()
mouseRemainUp(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','mouseRemainUp(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.mouseRest static method.

SYNTAX

mouseRest()
mouseRest(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','mouseRest(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.remainBlurred static method.

SYNTAX

remainBlurred()
remainBlurred(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','remainBlurred(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

The registered name for the virtual DOM event maker that is implemented in the Uize.Dom.VirtualEvents.Remain.remainFocused static method.

SYNTAX

remainFocused()
remainFocused(durationMsINT)

EXAMPLE

Uize.Dom.Basics.wire ('myNode','remainFocused(500)',function () {alert ('HELLO')});

NOTES

see related remain-in-state registered virtual DOM events

IMPLEMENTATION INFO

this feature was introduced in this module

IMPLEMENTATION INFO

this feature was introduced in this module