API reference up.layer

module

---

Features

• [up-accept] ATTR

  Accepts the current layer when this element is clicked or submitted.

• [up-close] ATTR deprecated

  When this element is clicked, closes a currently open overlay.

• [up-dismiss] ATTR

  Dismisses the current layer when this element is clicked or submitted.

• [up-drawer] ATTR deprecated

  Clicking this link will load the destination and open the given selector in a drawer overlay that slides in from the edge of the screen.

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

  Accepts the current layer.

• up:layer:accept EVENT

  This event is emitted before a layer is accepted.

• up:layer:accepted EVENT

  This event is emitted after a layer was accepted.

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

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

• up.layer.ask([options]) JS

  Opens an overlay and returns a promise for its acceptance.

• up.layer.config CONFIG

  Configures default attributes for new overlays.

• up.layer.contains(element) JS

  Returns whether the given element is contained by the current layer.

• up.layer.context JS experimental

  The context of the current layer.

• up.layer.count JS

  Returns the number of layers in the layer stack.

• up.layer.current JS

  Returns the current layer in the layer stack.

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

  Dismisses the current layer.

• up:layer:dismiss EVENT

  This event is emitted before a layer is dismissed.

• up:layer:dismissed EVENT

  This event is emitted after a layer was dismissed.

• up.layer.dismissOverlays([value], [options]) JS

  Dismisses all overlays.

• up.layer.element JS

  The outmost element of the current layer.

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

  Emits an event on the current layer's element.

• up.layer.front JS

  Returns the frontmost layer in the layer stack.

• up.layer.get([value]) JS

  Returns an up.Layer object for the given element or layer option.

• up.layer.getAll([layer]) JS experimental

  Returns an array of up.Layer objects matching the given layer option.

• up.layer.history JS

  Whether the current layer has visible history.

• up.layer.isFront() JS

  Returns whether the current layer is the frontmost layer.

• up.layer.isOverlay() JS

  Returns whether the current layer is not the root layer.

• up.layer.isRoot() JS

  Returns whether the current layer is the root layer.

• up.layer.location JS

  The location URL of the current layer.

• up:layer:location:changed EVENT

  This event is emitted after a layer's location property has changed value.

• up.layer.mode JS

  The current layer's mode, which governs its appearance and behavior.

• [up-layer=new] ATTR

  Shows the response to a link click or form submission within a new overlay.

• up.layer.off(types, listener) JS

  Unbinds an event listener previously bound to the current layer.

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

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

• up.layer.open([options]) JS

  Opens a new overlay.

• up:layer:open EVENT

  This event is emitted before an overlay is opened.

• up:layer:opened EVENT

  This event is emitted after a new overlay was placed into the DOM.

• up.layer.overlays JS

  Returns an array of all overlays.

• up.layer.parent JS

  Returns the parent layer of the current layer.

• up.layer.root JS

  Returns the root layer.

• up.layer.size JS

  The size of the current layer.

• up.layer.stack JS

  A list of layers that are currently open.

• [up-modal] ATTR deprecated

  Clicking this link will load the destination and open the given selector in a modal overlay.

• up.modal.close(options) JS deprecated

  Closes a currently open overlay.

• up.modal.config CONFIG deprecated

  Sets default options for future modal overlays.

• up.modal.contains(elementOrSelector) JS deprecated

  Returns whether the given element or selector is contained within the current layer.

• up.modal.coveredUrl() JS deprecated

  Returns the location URL of the layer behind the current overlay.

• up.modal.extract(selector, document, options) JS deprecated

  Extracts the given CSS selector from the given HTML string and opens the results in a modal overlay.

• up.modal.follow(linkOrSelector, [options]) JS deprecated

  Opens the given link's destination in a modal overlay.

• up.modal.isOpen() JS deprecated

  Returns whether an overlay is currently open.

• up.modal.url() JS deprecated

  Returns the location URL of the fragment displayed in the current overlay.

• up.modal.visit(url, options) JS deprecated

  Opens a modal overlay for the given URL.

• [up-popup] ATTR deprecated

  Clicking this link will load the destination and open the given selector in a popup overlay.

• up.popup.attach(anchor, [options]) JS deprecated

  Attaches a popup overlay to the given element or selector.

• up.popup.close(options) JS deprecated

  Closes a currently open overlay.

• up.popup.config CONFIG deprecated

  Sets default options for future popup overlays.

• up.popup.contains(elementOrSelector) JS deprecated

  Returns whether the given element or selector is contained within the current layer.

• up.popup.coveredUrl() JS deprecated

  Returns the location URL of the layer behind the current overlay.

• up.popup.isOpen() JS deprecated

  Returns whether an overlay is currently open.

• up.popup.url() JS deprecated

  Returns the location URL of the fragment displayed in the current overlay.