Unpoly - Progressive enhancement for HTML
3.14
API Tutorial Demo Install Changes Support GitHub Menu
/ ×
⏎ ENTER Full text search
Linking to fragments
Guides
Overview
Attributes and options
Targeting fragments
Handling all links and forms
Handling failed responses
Preloading links
Lazy loading content
Clicking non-interactive elements
HTML
[up-clickable]
[up-instant]
[up-dash]
[up-dash]
[up-defer]
[up-background]
[up-cache]
[up-defer]
[up-evict-cache]
[up-expire-cache]
[up-headers]
[up-href]
[up-intersect-margin]
[up-revalidate]
[up-revalidate-preview]
[up-target]
[up-expand]
[up-expand]
[up-follow]
[href]
[up-abort]
[up-abortable]
[up-animation]
[up-background]
[up-cache]
[up-confirm]
[up-content]
[up-context]
[up-disable]
[up-document]
[up-duration]
[up-easing]
[up-evict-cache]
[up-expire-cache]
[up-fail]
[up-fail-focus]
[up-fail-history]
[up-fail-layer]
[up-fail-scroll]
[up-fail-target]
[up-fallback]
[up-feedback]
[up-focus]
[up-focus-visible]
[up-fragment]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-match]
[up-meta-tags]
[up-method]
[up-navigate]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-rendered]
[up-params]
[up-peel]
[up-placeholder]
[up-preview]
[up-revalidate]
[up-revalidate-preview]
[up-reveal-max]
[up-reveal-padding]
[up-reveal-snap]
[up-reveal-top]
[up-save-focus]
[up-save-scroll]
[up-scroll]
[up-scroll-behavior]
[up-scroll-map]
[up-target]
[up-timeout]
[up-title]
[up-transition]
[up-use-data]
[up-use-data-map]
[up-use-hungry]
[up-use-keep]
[up-href]
[up-href]
[up-instant]
[up-preload]
[href]
[up-abortable]
[up-background]
[up-headers]
[up-intersect-margin]
[up-preload]
[up-preload-delay]
Events
up:click
up:deferred:load
up:link:follow
up:link:preload
JavaScript
up.deferred.load()
up.follow()
up.link.config config
config.clickableSelectors
config.followSelectors
config.instantSelectors
config.noClickableSelectors
config.noFollowSelectors
config.noInstantSelectors
config.noPreloadSelectors
config.preloadDelay
config.preloadSelectors
up.link.followOptions()
up.link.isFollowable()
up.link.isSafe()
up.link.makeFollowable()
up.link.preload()
Forms
Guides
Overview
Submitting forms
Validating forms
Switching form state
Reactive server forms
Disabling forms while working
Watch options
HTML
[up-autosubmit]
[up-watch-delay]
[up-watch-disable]
[up-watch-event]
[up-watch-feedback]
[up-watch-placeholder]
[up-watch-preview]
[up-disable-for]
[up-disable-for]
[up-enable-for]
[up-enable-for]
[up-fieldset]
[up-form-group]
[up-hide-for]
[up-hide-for]
[up-observe]
[up-observe]
[up-show-for]
[up-show-for]
[up-submit]
[action]
[method]
[up-abort]
[up-abortable]
[up-animation]
[up-background]
[up-cache]
[up-confirm]
[up-context]
[up-disable]
[up-duration]
[up-easing]
[up-evict-cache]
[up-expire-cache]
[up-fail-focus]
[up-fail-history]
[up-fail-layer]
[up-fail-scroll]
[up-fail-target]
[up-fallback]
[up-feedback]
[up-focus]
[up-focus-visible]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-match]
[up-meta-tags]
[up-navigate]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-rendered]
[up-params]
[up-peel]
[up-placeholder]
[up-preview]
[up-revalidate]
[up-revalidate-preview]
[up-reveal-max]
[up-reveal-padding]
[up-reveal-snap]
[up-reveal-top]
[up-save-focus]
[up-save-scroll]
[up-scroll]
[up-scroll-behavior]
[up-scroll-map]
[up-target]
[up-timeout]
[up-title]
[up-transition]
[up-use-data]
[up-use-data-map]
[up-use-hungry]
[up-use-keep]
[up-switch]
[up-switch]
[up-switch-region]
[up-watch-delay]
[up-watch-event]
[up-validate]
[up-validate]
[up-validate-batch]
[up-validate-headers]
[up-validate-method]
[up-validate-params]
[up-validate-url]
[up-watch-delay]
[up-watch-disable]
[up-watch-event]
[up-watch-feedback]
[up-watch-placeholder]
[up-watch-preview]
[up-watch]
[up-watch]
[up-watch-delay]
[up-watch-event]
Events
up:form:submit
up:form:switch
up:form:validate
JavaScript
up.autosubmit()
up.form.config config
config.arrayParam
config.fieldSelectors
config.genericButtonSelectors
config.groupSelectors
config.noSubmitSelectors
config.submitButtonSelectors
config.submitSelectors
config.validateBatch
config.watchChangeEvents
config.watchInputDelay
config.watchInputEvents
up.form.fields()
up.form.group()
up.form.isField()
up.form.isSubmittable()
up.form.submitButtons()
up.form.submitOptions()
up.observe()
up.submit()
up.validate()
up.watch()
up.Params class
new up.Params()
up.Params#add()
up.Params#addAll()
up.Params#addField()
up.Params#clear()
up.Params#delete()
up.Params#get()
up.Params#getAll()
up.Params#getFirst()
up.Params#set()
up.Params#toArray()
up.Params#toFormData()
up.Params#toObject()
up.Params#toQuery()
up.Params#toURL()
up.Params.fromFields()
up.Params.fromForm()
up.Params.fromURL()
up.Params.stripURL()
Custom JavaScript
Guides
Overview
Enhancing elements with JavaScript
Attaching data to elements
Migrating legacy JavaScripts
Handling changes in frontend code
Script security
HTML
[up-asset]
[up-data]
[up-data]
Events
up:assets:changed
JavaScript
up.compiler()
up.$compiler()
up.data()
up.destructor()
up.hello()
up.macro()
up.$macro()
up.script.config config
config.assetSelectors
config.cspNonce
config.cspWarnings
config.evalCallbackPolicy
config.noAssetSelectors
config.noScriptSelectors
config.scriptElementPolicy
config.scriptSelectors
Layers
Guides
Overview
Layer terminology
Layer option
Opening overlays
Closing overlays
Subinteractions
Customizing overlays
Layer context
HTML
[up-accept]
[up-accept]
[up-animation]
[up-confirm]
[up-duration]
[up-easing]
[up-close]
[up-dismiss]
[up-animation]
[up-confirm]
[up-dismiss]
[up-duration]
[up-easing]
[up-drawer]
[up-drawer]
[up-layer=new]
[href]
[up-abort]
[up-abortable]
[up-accept-event]
[up-accept-fragment]
[up-accept-location]
[up-align]
[up-animation]
[up-background]
[up-class]
[up-close-animation]
[up-close-duration]
[up-close-easing]
[up-confirm]
[up-content]
[up-context]
[up-dismiss-event]
[up-dismiss-fragment]
[up-dismiss-location]
[up-dismissible]
[up-document]
[up-duration]
[up-easing]
[up-fail]
[up-fail-history]
[up-fragment]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-meta-tags]
[up-method]
[up-mode]
[up-on-accepted]
[up-on-dismissed]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-opened]
[up-on-rendered]
[up-params]
[up-position]
[up-size]
[up-target]
[up-timeout]
[up-title]
[up-use-data]
[up-modal]
[up-modal]
[up-popup]
[up-popup]
Events
up:layer:accept
up:layer:accepted
up:layer:dismiss
up:layer:dismissed
up:layer:location:changed
up:layer:open
up:layer:opened
JavaScript
up.layer.accept()
up.layer.affix()
up.layer.ask()
up.layer.config config
config.any
config.any.mainTargets
config.cover
config.drawer
config.foreignOverlaySelectors
config.modal
config.mode
config.overlay
config.overlay.class
config.overlay.closeAnimation
config.overlay.closeDuration
config.overlay.closeEasing
config.overlay.dismissARIALabel
config.overlay.dismissLabel
config.overlay.history
config.overlay.openAnimation
config.overlay.openDuration
config.overlay.openEasing
config.overlay.trapFocus
config.popup
config.root
config.root.mainTargets
up.layer.contains()
up.layer.context
up.layer.count
up.layer.current
up.layer.dismiss()
up.layer.dismissOverlays()
up.layer.element
up.layer.emit()
up.layer.front
up.layer.get()
up.layer.getAll()
up.layer.history
up.layer.isFront()
up.layer.isOverlay()
up.layer.isRoot()
up.layer.location
up.layer.mode
up.layer.off()
up.layer.on()
up.layer.open()
up.layer.overlays
up.layer.parent
up.layer.root
up.layer.size
up.layer.stack
up.modal.close()
up.modal.config
up.modal.contains()
up.modal.coveredUrl()
up.modal.extract()
up.modal.follow()
up.modal.isOpen()
up.modal.url()
up.modal.visit()
up.motion.isEnabled()
up.popup.attach()
up.popup.close()
up.popup.config
up.popup.contains()
up.popup.coveredUrl()
up.popup.isOpen()
up.popup.url()
up.Layer class
up.Layer#accept()
up.Layer#affix()
up.Layer#align
up.Layer#ancestors
up.Layer#asCurrent()
up.Layer#child
up.Layer#contains()
up.Layer#context
up.Layer#descendants
up.Layer#dismiss()
up.Layer#element
up.Layer#emit()
up.Layer#history
up.Layer#index
up.Layer#isAlive()
up.Layer#isCurrent()
up.Layer#isFront()
up.Layer#isOverlay()
up.Layer#isRoot()
up.Layer#location
up.Layer#mode
up.Layer#off()
up.Layer#on()
up.Layer#origin
up.Layer#parent
up.Layer#peel()
up.Layer#position
up.Layer#size
up.Layer#subtree
up.Layer#sync()
up.Layer#title
Fragment API
Guides
Overview
Navigation
Providing HTML to render
Preserving elements
Templates
Render lifecycle
Skipping unnecessary rendering
Target derivation
HTML
:layer
:main
:maybe
:none
:origin
.up-destroying
[up-etag]
[up-etag]
[up-id]
[up-id]
[up-keep]
[up-keep]
[up-on-keep]
[up-main]
[up-main]
[up-source]
[up-source]
[up-time]
[up-time]
Events
up:fragment:aborted
up:fragment:destroyed
up:fragment:inserted
up:fragment:keep
up:fragment:kept
up:fragment:loaded
up:fragment:offline
up:template:clone
JavaScript
up.context
up.destroy()
up.extract()
up.fragment.abort()
up.fragment.all()
up.fragment.closest()
up.fragment.config config
config.autoFocus
config.autoHistoryTargets
config.autoRevalidate
config.autoScroll
config.badTargetClasses
config.mainTargets
config.match
config.navigateOptions
config.normalizeKeepHTML
config.reloadOptions
config.renderableResponse
config.renderOptions
config.skipResponse
config.targetDerivers
config.verifyDerivedTarget
up.fragment.contains()
up.fragment.etag()
up.fragment.first()
up.fragment.get()
up.fragment.isAlive()
up.fragment.isTargetable()
up.fragment.matches()
up.fragment.onAborted()
up.fragment.onKept()
up.fragment.source()
up.fragment.subtree()
up.fragment.time()
up.fragment.toTarget()
up.navigate()
up.reload()
up.render()
up.replace()
up.template.clone()
up.visit()
up.RenderJob class
up.RenderJob#finished
up.RenderJob#renderOptions
up.RenderJob#then()
up.RenderResult class
up.RenderResult#fragment
up.RenderResult#fragments
up.RenderResult#layer
up.RenderResult#none
up.RenderResult#ok
up.RenderResult#renderOptions
up.RenderResult#target
Passive updates
Guides
Overview
Polling
Notification flashes
HTML
[up-flashes]
[up-duration]
[up-easing]
[up-transition]
[up-hungry]
[up-duration]
[up-easing]
[up-if-layer]
[up-on-hungry]
[up-transition]
[up-poll]
[up-disable]
[up-fail]
[up-feedback]
[up-headers]
[up-href]
[up-if-layer]
[up-interval]
[up-keep-data]
[up-method]
[up-params]
[up-placeholder]
[up-preview]
Events
up:fragment:hungry
up:fragment:poll
JavaScript
up.radio.config config
config.hungrySelectors
config.noHungrySelectors
config.pollInterval
up.radio.startPolling()
up.radio.stopPolling()
Animation
Guides
Overview
Predefined animations
Predefined transitions
Motion tuning
HTML
[up-transition]
[up-duration]
[up-easing]
[up-fail-transition]
[up-transition]
Events
up:motion:finish
JavaScript
up.animate()
up.animation()
up.morph()
up.motion.config config
config.duration
config.easing
config.enabled
up.motion.finish()
up.transition()
Status effects
Guides
Overview
Navigation bars
Loading state
Feedback classes
Placeholders
Previews
Optimistic rendering
HTML
.up-active
[up-alias]
[up-alias]
.up-current
.up-loading
[up-nav]
[up-layer]
[up-placeholder]
[up-placeholder]
[up-preview]
[up-preview]
.up-revalidating
JavaScript
up.preview()
up.status.config config
config.activeClasses
config.currentClasses
config.loadingClasses
config.navSelectors
config.noNavSelectors
config.revalidatingClasses
up.Preview class
up.Preview#addClass()
up.Preview#disable()
up.Preview#ended
up.Preview#expiredResponse
up.Preview#fragment
up.Preview#hide()
up.Preview#hideContent()
up.Preview#insert()
up.Preview#layer
up.Preview#openLayer()
up.Preview#origin
up.Preview#params
up.Preview#removeClass()
up.Preview#renderOptions
up.Preview#request
up.Preview#revalidating
up.Preview#run()
up.Preview#setAttrs()
up.Preview#setStyle()
up.Preview#show()
up.Preview#showPlaceholder()
up.Preview#swapContent()
up.Preview#undo()
Network requests
Guides
Overview
Caching
Aborting requests
Handling network issues
Progress bar
Events
up:network:late
up:network:recover
up:request:aborted
up:request:load
up:request:loaded
up:request:offline
JavaScript
up.ajax()
up.cache.alias()
up.cache.clear()
up.cache.evict()
up.cache.expire()
up.cache.get()
up.network.abort()
up.network.config config
config.autoCache
config.cacheEvictAge
config.cacheExpireAge
config.cacheSize
config.concurrency
config.evictCache
config.expireCache
config.fail
config.lateDelay
config.progressBar
config.timeout
config.wrapMethod
up.network.isBusy()
up.network.isIdle()
up.network.loadPage()
up.proxy.clear()
up.proxy.preload()
up.request()
up.Request class
up.Request#abort()
up.Request#background
up.Request#badResponseTime
up.Request#contentType
up.Request#context
up.Request#ended
up.Request#failContext
up.Request#failLayer
up.Request#failMode
up.Request#failTarget
up.Request#fragment
up.Request#fragments
up.Request#hash
up.Request#header()
up.Request#headers
up.Request#isSafe()
up.Request#lateDelay
up.Request#layer
up.Request#loadPage()
up.Request#method
up.Request#mode
up.Request#navigate()
up.Request#origin
up.Request#originMode
up.Request#params
up.Request#payload
up.Request#preload
up.Request#target
up.Request#then()
up.Request#timeout
up.Request#url
up.Request#wrapMethod
up.Request#xhr
up.Response class
up.Response#age
up.Response#contentType
up.Response#context
up.Response#etag
up.Response#expired
up.Response#getHeader()
up.Response#header()
up.Response#isError()
up.Response#isHTML()
up.Response#isSuccess()
up.Response#json
up.Response#lastModified
up.Response#method
up.Response#ok
up.Response#status
up.Response#target
up.Response#text
up.Response#title
up.Response#url
up.Response#xhr
Events
Guides
Overview
HTML
[up-emit]
[up-emit]
[up-emit-props]
JavaScript
up.emit()
up.event.build()
up.event.halt()
up.event.inputDevice
up.event.nobodyPrevents()
up.event.onClosest()
up.event.onEscape()
up.off()
up.on()
up.$on()
Server protocol
Guides
Overview
Optimizing responses
Conditional requests
JavaScript
up.protocol.config config
config.csrfHeader
config.csrfParam
config.csrfToken
config.maxHeaderSize
config.methodParam
HTTP
ETag
If-Modified-Since
If-None-Match
Last-Modified
_up_method
Vary
X-Up-Accept-Layer
X-Up-Clear-Cache
X-Up-Context
X-Up-Dismiss-Layer
X-Up-Events
X-Up-Evict-Cache
X-Up-Expire-Cache
X-Up-Fail-Context
X-Up-Fail-Mode
X-Up-Fail-Target
X-Up-Location
X-Up-Method
X-Up-Mode
X-Up-Open-Layer
X-Up-Origin-Mode
X-Up-Reload-From-Time
X-Up-Target
X-Up-Title
X-Up-Validate
X-Up-Version
DOM helpers
Guides
Overview
HTML
[hidden]
JavaScript
up.element.affix()
up.element.all()
up.element.attr()
up.element.booleanAttr()
up.element.closest()
up.element.createFromHTML()
up.element.createFromSelector()
up.element.createNodesFromHTML()
up.element.first()
up.element.get()
up.element.hide()
up.element.isAttached()
up.element.isDetached()
up.element.isEmpty()
up.element.isVisible()
up.element.jsonAttr()
up.element.matches()
up.element.numberAttr()
up.element.remove()
up.element.replace()
up.element.setAttrs()
up.element.setStyle()
up.element.show()
up.element.style()
up.element.styleNumber()
up.element.subtree()
up.element.toggle()
up.element.toggleClass()
up.element.toSelector()
Scrolling and focus
Guides
Overview
Scrolling
Tuning the scroll behavior
Controlling focus
Focus ring visibility
Infinite scrolling
HTML
[up-anchored=right]
[up-fixed=bottom]
[up-fixed=top]
.up-focus-hidden
.up-focus-visible
.up-scrollbar-away
[up-viewport]
JavaScript
up.focus()
up.reveal()
up.scroll()
up.viewport.closest()
up.viewport.config config
config.anchoredRightSelectors
config.autoFocusVisible
config.fixedBottomSelectors
config.fixedTopSelectors
config.revealMax
config.revealPadding
config.revealSnap
config.revealTop
config.viewportSelectors
up.viewport.get()
up.viewport.restoreFocus()
up.viewport.restoreScroll()
up.viewport.root
up.viewport.saveFocus()
up.viewport.saveScroll()
History
Guides
Overview
Updating history
Restoring history
History in overlays
Tracking page views
HTML
[up-back]
[up-meta]
Events
up:location:changed
up:location:restore
JavaScript
up.history.config config
config.enabled
config.metaTagSelectors
config.noMetaTagSelectors
config.restoreTargets
config.updateMetaTags
up.history.isLocation()
up.history.location
up.history.previousLocation
up.history.push()
up.history.replace()
up.history.url()
Utility functions
Guides
Overview
Relaxed JSON
URL patterns
JavaScript
up.util.assign()
up.util.compact()
up.util.contains()
up.util.copy()
up.util.copy.key
up.util.each()
up.util.escapeHTML()
up.util.evalOption()
up.util.every()
up.util.except()
up.util.filter()
up.util.find()
up.util.findResult()
up.util.flatMap()
up.util.flatten()
up.util.isArray()
up.util.isBlank()
up.util.isBlank.key
up.util.isBoolean()
up.util.isDefined()
up.util.isElement()
up.util.isEqual()
up.util.isEqual.key
up.util.isFunction()
up.util.isGiven()
up.util.isJQuery()
up.util.isList()
up.util.isMissing()
up.util.isNull()
up.util.isNumber()
up.util.isObject()
up.util.isPresent()
up.util.isPromise()
up.util.isString()
up.util.isUndefined()
up.util.last()
up.util.map()
up.util.mapObject()
up.util.merge()
up.util.microtask()
up.util.noop()
up.util.normalizeURL()
up.util.omit()
up.util.only()
up.util.parseNumber()
up.util.parseRelaxedJSON()
up.util.parseURL()
up.util.pick()
up.util.pickBy()
up.util.pluckKey()
up.util.presence()
up.util.reject()
up.util.remove()
up.util.some()
up.util.task()
up.util.timer()
up.util.times()
up.util.toArray()
up.util.uniq()
up.util.uniqBy()
up.util.values()
up.util.wrapList()
Framework initialization
Guides
Overview
HTML
[up-boot=manual]
Events
up:framework:booted
JavaScript
up.boot()
up.framework.booted
up.framework.isSupported()
Logging
Guides
Overview
JavaScript
up.log.config config
config.banner
config.enabled
config.format
up.log.disable()
up.log.enable()
/ ×
⏎ ENTER Full text search
Linking to fragments
Guides
Overview
Attributes and options
Targeting fragments
Handling all links and forms
Handling failed responses
Preloading links
Lazy loading content
Clicking non-interactive elements
HTML
[up-clickable]
[up-instant]
[up-dash]
[up-dash]
[up-defer]
[up-background]
[up-cache]
[up-defer]
[up-evict-cache]
[up-expire-cache]
[up-headers]
[up-href]
[up-intersect-margin]
[up-revalidate]
[up-revalidate-preview]
[up-target]
[up-expand]
[up-expand]
[up-follow]
[href]
[up-abort]
[up-abortable]
[up-animation]
[up-background]
[up-cache]
[up-confirm]
[up-content]
[up-context]
[up-disable]
[up-document]
[up-duration]
[up-easing]
[up-evict-cache]
[up-expire-cache]
[up-fail]
[up-fail-focus]
[up-fail-history]
[up-fail-layer]
[up-fail-scroll]
[up-fail-target]
[up-fallback]
[up-feedback]
[up-focus]
[up-focus-visible]
[up-fragment]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-match]
[up-meta-tags]
[up-method]
[up-navigate]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-rendered]
[up-params]
[up-peel]
[up-placeholder]
[up-preview]
[up-revalidate]
[up-revalidate-preview]
[up-reveal-max]
[up-reveal-padding]
[up-reveal-snap]
[up-reveal-top]
[up-save-focus]
[up-save-scroll]
[up-scroll]
[up-scroll-behavior]
[up-scroll-map]
[up-target]
[up-timeout]
[up-title]
[up-transition]
[up-use-data]
[up-use-data-map]
[up-use-hungry]
[up-use-keep]
[up-href]
[up-href]
[up-instant]
[up-preload]
[href]
[up-abortable]
[up-background]
[up-headers]
[up-intersect-margin]
[up-preload]
[up-preload-delay]
Events
up:click
up:deferred:load
up:link:follow
up:link:preload
JavaScript
up.deferred.load()
up.follow()
up.link.config config
config.clickableSelectors
config.followSelectors
config.instantSelectors
config.noClickableSelectors
config.noFollowSelectors
config.noInstantSelectors
config.noPreloadSelectors
config.preloadDelay
config.preloadSelectors
up.link.followOptions()
up.link.isFollowable()
up.link.isSafe()
up.link.makeFollowable()
up.link.preload()
Forms
Guides
Overview
Submitting forms
Validating forms
Switching form state
Reactive server forms
Disabling forms while working
Watch options
HTML
[up-autosubmit]
[up-watch-delay]
[up-watch-disable]
[up-watch-event]
[up-watch-feedback]
[up-watch-placeholder]
[up-watch-preview]
[up-disable-for]
[up-disable-for]
[up-enable-for]
[up-enable-for]
[up-fieldset]
[up-form-group]
[up-hide-for]
[up-hide-for]
[up-observe]
[up-observe]
[up-show-for]
[up-show-for]
[up-submit]
[action]
[method]
[up-abort]
[up-abortable]
[up-animation]
[up-background]
[up-cache]
[up-confirm]
[up-context]
[up-disable]
[up-duration]
[up-easing]
[up-evict-cache]
[up-expire-cache]
[up-fail-focus]
[up-fail-history]
[up-fail-layer]
[up-fail-scroll]
[up-fail-target]
[up-fallback]
[up-feedback]
[up-focus]
[up-focus-visible]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-match]
[up-meta-tags]
[up-navigate]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-rendered]
[up-params]
[up-peel]
[up-placeholder]
[up-preview]
[up-revalidate]
[up-revalidate-preview]
[up-reveal-max]
[up-reveal-padding]
[up-reveal-snap]
[up-reveal-top]
[up-save-focus]
[up-save-scroll]
[up-scroll]
[up-scroll-behavior]
[up-scroll-map]
[up-target]
[up-timeout]
[up-title]
[up-transition]
[up-use-data]
[up-use-data-map]
[up-use-hungry]
[up-use-keep]
[up-switch]
[up-switch]
[up-switch-region]
[up-watch-delay]
[up-watch-event]
[up-validate]
[up-validate]
[up-validate-batch]
[up-validate-headers]
[up-validate-method]
[up-validate-params]
[up-validate-url]
[up-watch-delay]
[up-watch-disable]
[up-watch-event]
[up-watch-feedback]
[up-watch-placeholder]
[up-watch-preview]
[up-watch]
[up-watch]
[up-watch-delay]
[up-watch-event]
Events
up:form:submit
up:form:switch
up:form:validate
JavaScript
up.autosubmit()
up.form.config config
config.arrayParam
config.fieldSelectors
config.genericButtonSelectors
config.groupSelectors
config.noSubmitSelectors
config.submitButtonSelectors
config.submitSelectors
config.validateBatch
config.watchChangeEvents
config.watchInputDelay
config.watchInputEvents
up.form.fields()
up.form.group()
up.form.isField()
up.form.isSubmittable()
up.form.submitButtons()
up.form.submitOptions()
up.observe()
up.submit()
up.validate()
up.watch()
up.Params class
new up.Params()
up.Params#add()
up.Params#addAll()
up.Params#addField()
up.Params#clear()
up.Params#delete()
up.Params#get()
up.Params#getAll()
up.Params#getFirst()
up.Params#set()
up.Params#toArray()
up.Params#toFormData()
up.Params#toObject()
up.Params#toQuery()
up.Params#toURL()
up.Params.fromFields()
up.Params.fromForm()
up.Params.fromURL()
up.Params.stripURL()
Custom JavaScript
Guides
Overview
Enhancing elements with JavaScript
Attaching data to elements
Migrating legacy JavaScripts
Handling changes in frontend code
Script security
HTML
[up-asset]
[up-data]
[up-data]
Events
up:assets:changed
JavaScript
up.compiler()
up.$compiler()
up.data()
up.destructor()
up.hello()
up.macro()
up.$macro()
up.script.config config
config.assetSelectors
config.cspNonce
config.cspWarnings
config.evalCallbackPolicy
config.noAssetSelectors
config.noScriptSelectors
config.scriptElementPolicy
config.scriptSelectors
Layers
Guides
Overview
Layer terminology
Layer option
Opening overlays
Closing overlays
Subinteractions
Customizing overlays
Layer context
HTML
[up-accept]
[up-accept]
[up-animation]
[up-confirm]
[up-duration]
[up-easing]
[up-close]
[up-dismiss]
[up-animation]
[up-confirm]
[up-dismiss]
[up-duration]
[up-easing]
[up-drawer]
[up-drawer]
[up-layer=new]
[href]
[up-abort]
[up-abortable]
[up-accept-event]
[up-accept-fragment]
[up-accept-location]
[up-align]
[up-animation]
[up-background]
[up-class]
[up-close-animation]
[up-close-duration]
[up-close-easing]
[up-confirm]
[up-content]
[up-context]
[up-dismiss-event]
[up-dismiss-fragment]
[up-dismiss-location]
[up-dismissible]
[up-document]
[up-duration]
[up-easing]
[up-fail]
[up-fail-history]
[up-fragment]
[up-headers]
[up-history]
[up-lang]
[up-late-delay]
[up-layer]
[up-location]
[up-meta-tags]
[up-method]
[up-mode]
[up-on-accepted]
[up-on-dismissed]
[up-on-error]
[up-on-finished]
[up-on-loaded]
[up-on-offline]
[up-on-opened]
[up-on-rendered]
[up-params]
[up-position]
[up-size]
[up-target]
[up-timeout]
[up-title]
[up-use-data]
[up-modal]
[up-modal]
[up-popup]
[up-popup]
Events
up:layer:accept
up:layer:accepted
up:layer:dismiss
up:layer:dismissed
up:layer:location:changed
up:layer:open
up:layer:opened
JavaScript
up.layer.accept()
up.layer.affix()
up.layer.ask()
up.layer.config config
config.any
config.any.mainTargets
config.cover
config.drawer
config.foreignOverlaySelectors
config.modal
config.mode
config.overlay
config.overlay.class
config.overlay.closeAnimation
config.overlay.closeDuration
config.overlay.closeEasing
config.overlay.dismissARIALabel
config.overlay.dismissLabel
config.overlay.history
config.overlay.openAnimation
config.overlay.openDuration
config.overlay.openEasing
config.overlay.trapFocus
config.popup
config.root
config.root.mainTargets
up.layer.contains()
up.layer.context
up.layer.count
up.layer.current
up.layer.dismiss()
up.layer.dismissOverlays()
up.layer.element
up.layer.emit()
up.layer.front
up.layer.get()
up.layer.getAll()
up.layer.history
up.layer.isFront()
up.layer.isOverlay()
up.layer.isRoot()
up.layer.location
up.layer.mode
up.layer.off()
up.layer.on()
up.layer.open()
up.layer.overlays
up.layer.parent
up.layer.root
up.layer.size
up.layer.stack
up.modal.close()
up.modal.config
up.modal.contains()
up.modal.coveredUrl()
up.modal.extract()
up.modal.follow()
up.modal.isOpen()
up.modal.url()
up.modal.visit()
up.motion.isEnabled()
up.popup.attach()
up.popup.close()
up.popup.config
up.popup.contains()
up.popup.coveredUrl()
up.popup.isOpen()
up.popup.url()
up.Layer class
up.Layer#accept()
up.Layer#affix()
up.Layer#align
up.Layer#ancestors
up.Layer#asCurrent()
up.Layer#child
up.Layer#contains()
up.Layer#context
up.Layer#descendants
up.Layer#dismiss()
up.Layer#element
up.Layer#emit()
up.Layer#history
up.Layer#index
up.Layer#isAlive()
up.Layer#isCurrent()
up.Layer#isFront()
up.Layer#isOverlay()
up.Layer#isRoot()
up.Layer#location
up.Layer#mode
up.Layer#off()
up.Layer#on()
up.Layer#origin
up.Layer#parent
up.Layer#peel()
up.Layer#position
up.Layer#size
up.Layer#subtree
up.Layer#sync()
up.Layer#title
Fragment API
Guides
Overview
Navigation
Providing HTML to render
Preserving elements
Templates
Render lifecycle
Skipping unnecessary rendering
Target derivation
HTML
:layer
:main
:maybe
:none
:origin
.up-destroying
[up-etag]
[up-etag]
[up-id]
[up-id]
[up-keep]
[up-keep]
[up-on-keep]
[up-main]
[up-main]
[up-source]
[up-source]
[up-time]
[up-time]
Events
up:fragment:aborted
up:fragment:destroyed
up:fragment:inserted
up:fragment:keep
up:fragment:kept
up:fragment:loaded
up:fragment:offline
up:template:clone
JavaScript
up.context
up.destroy()
up.extract()
up.fragment.abort()
up.fragment.all()
up.fragment.closest()
up.fragment.config config
config.autoFocus
config.autoHistoryTargets
config.autoRevalidate
config.autoScroll
config.badTargetClasses
config.mainTargets
config.match
config.navigateOptions
config.normalizeKeepHTML
config.reloadOptions
config.renderableResponse
config.renderOptions
config.skipResponse
config.targetDerivers
config.verifyDerivedTarget
up.fragment.contains()
up.fragment.etag()
up.fragment.first()
up.fragment.get()
up.fragment.isAlive()
up.fragment.isTargetable()
up.fragment.matches()
up.fragment.onAborted()
up.fragment.onKept()
up.fragment.source()
up.fragment.subtree()
up.fragment.time()
up.fragment.toTarget()
up.navigate()
up.reload()
up.render()
up.replace()
up.template.clone()
up.visit()
up.RenderJob class
up.RenderJob#finished
up.RenderJob#renderOptions
up.RenderJob#then()
up.RenderResult class
up.RenderResult#fragment
up.RenderResult#fragments
up.RenderResult#layer
up.RenderResult#none
up.RenderResult#ok
up.RenderResult#renderOptions
up.RenderResult#target
Passive updates
Guides
Overview
Polling
Notification flashes
HTML
[up-flashes]
[up-duration]
[up-easing]
[up-transition]
[up-hungry]
[up-duration]
[up-easing]
[up-if-layer]
[up-on-hungry]
[up-transition]
[up-poll]
[up-disable]
[up-fail]
[up-feedback]
[up-headers]
[up-href]
[up-if-layer]
[up-interval]
[up-keep-data]
[up-method]
[up-params]
[up-placeholder]
[up-preview]
Events
up:fragment:hungry
up:fragment:poll
JavaScript
up.radio.config config
config.hungrySelectors
config.noHungrySelectors
config.pollInterval
up.radio.startPolling()
up.radio.stopPolling()
Animation
Guides
Overview
Predefined animations
Predefined transitions
Motion tuning
HTML
[up-transition]
[up-duration]
[up-easing]
[up-fail-transition]
[up-transition]
Events
up:motion:finish
JavaScript
up.animate()
up.animation()
up.morph()
up.motion.config config
config.duration
config.easing
config.enabled
up.motion.finish()
up.transition()
Status effects
Guides
Overview
Navigation bars
Loading state
Feedback classes
Placeholders
Previews
Optimistic rendering
HTML
.up-active
[up-alias]
[up-alias]
.up-current
.up-loading
[up-nav]
[up-layer]
[up-placeholder]
[up-placeholder]
[up-preview]
[up-preview]
.up-revalidating
JavaScript
up.preview()
up.status.config config
config.activeClasses
config.currentClasses
config.loadingClasses
config.navSelectors
config.noNavSelectors
config.revalidatingClasses
up.Preview class
up.Preview#addClass()
up.Preview#disable()
up.Preview#ended
up.Preview#expiredResponse
up.Preview#fragment
up.Preview#hide()
up.Preview#hideContent()
up.Preview#insert()
up.Preview#layer
up.Preview#openLayer()
up.Preview#origin
up.Preview#params
up.Preview#removeClass()
up.Preview#renderOptions
up.Preview#request
up.Preview#revalidating
up.Preview#run()
up.Preview#setAttrs()
up.Preview#setStyle()
up.Preview#show()
up.Preview#showPlaceholder()
up.Preview#swapContent()
up.Preview#undo()
Network requests
Guides
Overview
Caching
Aborting requests
Handling network issues
Progress bar
Events
up:network:late
up:network:recover
up:request:aborted
up:request:load
up:request:loaded
up:request:offline
JavaScript
up.ajax()
up.cache.alias()
up.cache.clear()
up.cache.evict()
up.cache.expire()
up.cache.get()
up.network.abort()
up.network.config config
config.autoCache
config.cacheEvictAge
config.cacheExpireAge
config.cacheSize
config.concurrency
config.evictCache
config.expireCache
config.fail
config.lateDelay
config.progressBar
config.timeout
config.wrapMethod
up.network.isBusy()
up.network.isIdle()
up.network.loadPage()
up.proxy.clear()
up.proxy.preload()
up.request()
up.Request class
up.Request#abort()
up.Request#background
up.Request#badResponseTime
up.Request#contentType
up.Request#context
up.Request#ended
up.Request#failContext
up.Request#failLayer
up.Request#failMode
up.Request#failTarget
up.Request#fragment
up.Request#fragments
up.Request#hash
up.Request#header()
up.Request#headers
up.Request#isSafe()
up.Request#lateDelay
up.Request#layer
up.Request#loadPage()
up.Request#method
up.Request#mode
up.Request#navigate()
up.Request#origin
up.Request#originMode
up.Request#params
up.Request#payload
up.Request#preload
up.Request#target
up.Request#then()
up.Request#timeout
up.Request#url
up.Request#wrapMethod
up.Request#xhr
up.Response class
up.Response#age
up.Response#contentType
up.Response#context
up.Response#etag
up.Response#expired
up.Response#getHeader()
up.Response#header()
up.Response#isError()
up.Response#isHTML()
up.Response#isSuccess()
up.Response#json
up.Response#lastModified
up.Response#method
up.Response#ok
up.Response#status
up.Response#target
up.Response#text
up.Response#title
up.Response#url
up.Response#xhr
Events
Guides
Overview
HTML
[up-emit]
[up-emit]
[up-emit-props]
JavaScript
up.emit()
up.event.build()
up.event.halt()
up.event.inputDevice
up.event.nobodyPrevents()
up.event.onClosest()
up.event.onEscape()
up.off()
up.on()
up.$on()
Server protocol
Guides
Overview
Optimizing responses
Conditional requests
JavaScript
up.protocol.config config
config.csrfHeader
config.csrfParam
config.csrfToken
config.maxHeaderSize
config.methodParam
HTTP
ETag
If-Modified-Since
If-None-Match
Last-Modified
_up_method
Vary
X-Up-Accept-Layer
X-Up-Clear-Cache
X-Up-Context
X-Up-Dismiss-Layer
X-Up-Events
X-Up-Evict-Cache
X-Up-Expire-Cache
X-Up-Fail-Context
X-Up-Fail-Mode
X-Up-Fail-Target
X-Up-Location
X-Up-Method
X-Up-Mode
X-Up-Open-Layer
X-Up-Origin-Mode
X-Up-Reload-From-Time
X-Up-Target
X-Up-Title
X-Up-Validate
X-Up-Version
DOM helpers
Guides
Overview
HTML
[hidden]
JavaScript
up.element.affix()
up.element.all()
up.element.attr()
up.element.booleanAttr()
up.element.closest()
up.element.createFromHTML()
up.element.createFromSelector()
up.element.createNodesFromHTML()
up.element.first()
up.element.get()
up.element.hide()
up.element.isAttached()
up.element.isDetached()
up.element.isEmpty()
up.element.isVisible()
up.element.jsonAttr()
up.element.matches()
up.element.numberAttr()
up.element.remove()
up.element.replace()
up.element.setAttrs()
up.element.setStyle()
up.element.show()
up.element.style()
up.element.styleNumber()
up.element.subtree()
up.element.toggle()
up.element.toggleClass()
up.element.toSelector()
Scrolling and focus
Guides
Overview
Scrolling
Tuning the scroll behavior
Controlling focus
Focus ring visibility
Infinite scrolling
HTML
[up-anchored=right]
[up-fixed=bottom]
[up-fixed=top]
.up-focus-hidden
.up-focus-visible
.up-scrollbar-away
[up-viewport]
JavaScript
up.focus()
up.reveal()
up.scroll()
up.viewport.closest()
up.viewport.config config
config.anchoredRightSelectors
config.autoFocusVisible
config.fixedBottomSelectors
config.fixedTopSelectors
config.revealMax
config.revealPadding
config.revealSnap
config.revealTop
config.viewportSelectors
up.viewport.get()
up.viewport.restoreFocus()
up.viewport.restoreScroll()
up.viewport.root
up.viewport.saveFocus()
up.viewport.saveScroll()
History
Guides
Overview
Updating history
Restoring history
History in overlays
Tracking page views
HTML
[up-back]
[up-meta]
Events
up:location:changed
up:location:restore
JavaScript
up.history.config config
config.enabled
config.metaTagSelectors
config.noMetaTagSelectors
config.restoreTargets
config.updateMetaTags
up.history.isLocation()
up.history.location
up.history.previousLocation
up.history.push()
up.history.replace()
up.history.url()
Utility functions
Guides
Overview
Relaxed JSON
URL patterns
JavaScript
up.util.assign()
up.util.compact()
up.util.contains()
up.util.copy()
up.util.copy.key
up.util.each()
up.util.escapeHTML()
up.util.evalOption()
up.util.every()
up.util.except()
up.util.filter()
up.util.find()
up.util.findResult()
up.util.flatMap()
up.util.flatten()
up.util.isArray()
up.util.isBlank()
up.util.isBlank.key
up.util.isBoolean()
up.util.isDefined()
up.util.isElement()
up.util.isEqual()
up.util.isEqual.key
up.util.isFunction()
up.util.isGiven()
up.util.isJQuery()
up.util.isList()
up.util.isMissing()
up.util.isNull()
up.util.isNumber()
up.util.isObject()
up.util.isPresent()
up.util.isPromise()
up.util.isString()
up.util.isUndefined()
up.util.last()
up.util.map()
up.util.mapObject()
up.util.merge()
up.util.microtask()
up.util.noop()
up.util.normalizeURL()
up.util.omit()
up.util.only()
up.util.parseNumber()
up.util.parseRelaxedJSON()
up.util.parseURL()
up.util.pick()
up.util.pickBy()
up.util.pluckKey()
up.util.presence()
up.util.reject()
up.util.remove()
up.util.some()
up.util.task()
up.util.timer()
up.util.times()
up.util.toArray()
up.util.uniq()
up.util.uniqBy()
up.util.values()
up.util.wrapList()
Framework initialization
Guides
Overview
HTML
[up-boot=manual]
Events
up:framework:booted
JavaScript
up.boot()
up.framework.booted
up.framework.isSupported()
Logging
Guides
Overview
JavaScript
up.log.config config
config.banner
config.enabled
config.format
up.log.disable()
up.log.enable()
Made by Henning Koch
Imprint
Privacy policy