API reference up.Layer

class

---

Features

• up.Layer.prototype.accept([value], [options]) JS

  Closes this overlay with an accepting intent, e.g. when a change was confirmed or when a value was selected.

• up.Layer.prototype.affix(selector, [attrs]) JS experimental

  Creates an element with the given selector and appends it to this layer's content.

• up.Layer.prototype.align JS

  The alignment of this popup overlay.

• up.Layer.prototype.ancestors JS

  Returns an array of this layer's ancestor layers.

• up.Layer.prototype.asCurrent(fn) JS

  Temporarily changes the current layer while the given function is running.

• up.Layer.prototype.child JS

  Returns this layer's child layer.

• up.Layer.prototype.contains(element) JS

  Returns whether the given element is contained by this layer.

• up.Layer.prototype.context JS experimental

  This layer's context.

• up.Layer.prototype.descendants JS

  Returns an array of this layer's descendant layers, with the closest descendants listed first.

• up.Layer.prototype.dismiss([value], [options]) JS

  Closes this overlay without an accepting intent, e.g. when a "Cancel" button was clicked.

• up.Layer.prototype.element JS

  This layer's outmost container element.

• up.Layer.prototype.emit(eventType, [props]) JS

  Emits an event on this layer's element.

• up.Layer.prototype.history JS

  Whether this layer has visible history.

• up.Layer.prototype.index JS

  Returns the zero-based position of this layer in the layer stack.

• up.Layer.prototype.isAlive() JS

  Returns whether this layer is part of the layer stack and can be interacted with.

• up.Layer.prototype.isClosed() JS deprecated

  Returns whether this layer is no longer part of the layer stack.

• up.Layer.prototype.isCurrent() JS

  Returns whether this layer is the current layer.

• up.Layer.prototype.isFront() JS

  Returns whether this layer is the frontmost layer.

• up.Layer.prototype.isOpen() JS deprecated

  Returns whether this layer is still part of the layer stack.

• up.Layer.prototype.isOverlay() JS

  Returns whether this layer is not the root layer.

• up.Layer.prototype.isRoot() JS

  Returns whether this layer is the root layer.

• up.Layer.prototype.location JS experimental

  This layer's location URL.

• up.Layer.prototype.mode JS

  This layer's mode which governs its appearance and behavior.

• up.Layer.prototype.off(types, listener) JS

  Unbinds an event listener previously bound with up.Layer#on().

• up.Layer.prototype.on(types, [selector], [options], listener) JS

  Listens to a DOM event that originated on an element contained by this layer.

• up.Layer.prototype.origin JS

  The button or link that opened this overlay.

• up.Layer.prototype.parent JS

  Returns this layer's parent layer.

• up.Layer.prototype.peel([options]) JS

  Dismisses all descendant overlays, making this layer the frontmost layer in the layer stack.

• up.Layer.prototype.position JS

  The position of this popup or drawer overlay.

• up.Layer.prototype.size JS

  The size of this overlay.

• up.Layer.prototype.subtree JS experimental

  Returns an array of this layer and its descendant layers, with the closest descendants listed first.

• up.Layer.prototype.sync() JS experimental

  Synchronizes this layer with the rest of the page.

• up.Layer.prototype.title JS experimental

  This layer's window title.