up.layer [up-layer=new]

HTML selector

Whether to stack the new overlay onto the current layer or replace existing overlays.

See replacing existing overlays.

The kind of overlay to open.

See available layer modes.

The size of the overlay.

See overlay sizes for details.

An optional HTML class for the overlay's container element.

See overlay classes.

Whether the overlay has visible history.

If set to 'true' the overlay location, title and meta tags will be shown while the overlay is open. When the overlay is closed, the parent layer's history is restored.

If set to 'auto' history will be visible if the initial overlay content matches a main target.

If set to 'false', fragments changes within the overlay will never update the address bar. You can still access the overlay's current location using up.layer.location.

See History in overlays.

How the overlay may be dismissed by the user.

See customizing dismiss controls for details.

You may enable multiple dismiss controls by passing a space-separated string.

Passing true or false will enable or disable all dismiss controls.

The name of the opening animation.

A JavaScript snippet that is called when the overlay was inserted into the DOM.

The snippet runs in the following scope:

A JavaScript snippet that is called when the overlay was accepted.

The snippet runs in the following scope:

A JavaScript snippet that is called when the overlay was dismissed.

The snippet runs in the following scope:

One or more space-separated event types that will cause this overlay to automatically be accepted when a matching event occurs within the overlay.

The overlay result value is the event object that caused the overlay to close.

See Closing when an event is emitted.

One or more space-separated event types that will cause this overlay to automatically be dismissed when a matching event occurs within the overlay.

The overlay result value is the event object that caused the overlay to close.

See Closing when an event is emitted.

One or more space-separated URL patterns that will cause this overlay to automatically be accepted when the overlay reaches a matching location.

The overlay result value is an object of named segments matches captured by the URL pattern.

See Closing when a location is reached.

One or more space-separated URL patterns that will cause this overlay to automatically be dismissed when the overlay reaches a matching location.

The overlay result value is an object of named segments matches captured by the URL pattern.

See Closing when a location is reached.

The new overlay's context object, encoded as JSON.

The position of the popup relative to the { origin } element that opened the overlay.

Supported values are top, right, bottom and left.

See popup position.

The alignment of the popup within its { position }.

Supported values are top, right, center, bottom and left.

See popup position.