- Supported by:
- Popups for Divi
- Divi Areas Pro
A full list of all public JS API functions that are available on the front end of your website when either Popups for Divi or Divi Areas Pro is active.
This is an advanced API for developers – if you don’t know how to use the JavaScript console and have not written custom JavaScript for your Divi website before, then please refer to some other tutorials in our blog or knowledge base.
DiviArea
DiviArea.removeFilter(hook, callback)DiviArea.removeAction(hook, callback)DiviArea.applyFilters(hook, value, ...params)DiviArea.doAction(hook, ...params)DiviArea.addFilter(hook, callback, priority, context)DiviArea.addAction(hook, callback, priority, context)DiviArea.addActionOnce(hook, callback, priority, context)DiviArea.register(element, options, type)DiviArea.show(area, event)DiviArea.hide(area)DiviArea.showOverlay()DiviArea.hideOverlay()DiviArea.getOverlay()DiviArea.listAreas(filter)DiviArea.getArea(id)DiviArea.markClosed(key, closeFor)DiviArea.isClosed(key)
DiviArea.Hooks
DiviArea.Hooks.removeFilter(hook, callback)DiviArea.Hooks.removeAction(hook, callback)DiviArea.Hooks.applyFilters(hook, value, ...params)DiviArea.Hooks.doAction(hook, ...params)DiviArea.Hooks.addFilter(hook, callback, priority, context)DiviArea.Hooks.addAction(hook, callback, priority, context)DiviArea.Hooks.addActionOnce(hook, callback, priority, context)
DiviArea.Utils
DiviArea.Utils.getOption(key)DiviArea.Utils.toBool(value, undefinedValue)DiviArea.Utils.toMilliseconds(value)DiviArea.Utils.sanitizeHookName(name)DiviArea.Utils.showOnViewport(area)DiviArea.Utils.isPosition(container, positionType)DiviArea.Utils.setLocalData(key, value, expiration)DiviArea.Utils.getLocalData(key)DiviArea.Utils.setCookie(cookieName, value, lifespan)DiviArea.Utils.getCookie(cookieName)DiviArea.Utils.getUrlParam(paramName)DiviArea.Utils.getWindow(elem)DiviArea.Utils.getClientRect(elem)DiviArea.Utils.toPixel(value, unit, element)DiviArea.Utils.getStyleDef(element, prop, ignore)DiviArea.Utils.getCssSpecificity(selector, attribValue)DiviArea.Utils.compareCssSpecificity(a, b)
DiviArea.Core
DiviArea.Core.isArea(value)DiviArea.Core.getContext()DiviArea.Core.reOrderAreas()DiviArea.Core.activateContainer(context)DiviArea.Core.initContainer(context)DiviArea.Core.deactivateContainer(area)DiviArea.Core.attachArea(area)DiviArea.Core.detachArea(area)DiviArea.Core.focusArea(area)DiviArea.Core.blurArea(area)DiviArea.Core.setupHoverArea(area)DiviArea.Core.disableBodyScroll()DiviArea.Core.enableBodyScroll()DiviArea.Core.closeMainMenu()
DiviArea.Data
DiviArea.Data.sanitizeId(id, linkPrefix)DiviArea.Data.getRealId(id)DiviArea.Data.addAltId(id, altId)DiviArea.Data.getArea(id)DiviArea.Data.createArea(element, type, id)DiviArea.Data.getAllIds(filter)DiviArea.Data.loopAllAreas(filter, callback)DiviArea.Data.countVisibleAreas(filter)DiviArea.Data.addVisibleArea(area)DiviArea.Data.removeVisibleArea(area)DiviArea.Data.getVisibleArea(id, type)DiviArea.Data.loopVisibleAreas(filter, callback, reversed)
DiviArea.UI
DiviArea.Debug
DiviArea.Debug.group(label)DiviArea.Debug.table(args)DiviArea.Debug.verbose(...args)DiviArea.Debug.debug(...args)DiviArea.Debug.info(...args)DiviArea.Debug.error(...args)DiviArea.Debug.sysInfo()
DiviAreaItem
The following methods are available for all DiviAreaItem instances.
DiviAreaItem.theId()DiviAreaItem.theKey()DiviAreaItem.hasId(id)DiviAreaItem.theType()DiviAreaItem.isType(expected)DiviAreaItem.get(selector)DiviAreaItem.getWrap()DiviAreaItem.attach()DiviAreaItem.detach()DiviAreaItem.findHook()DiviAreaItem.setVisible(state, onDone)DiviAreaItem.setPosition()DiviAreaItem.setTriggerEvent(event)DiviAreaItem.isVisible()DiviAreaItem.inDom()DiviAreaItem.getSize()DiviAreaItem.getData(key)DiviAreaItem.setData(key, value)DiviAreaItem.doAction(hook, …params)DiviAreaItem.applyFilters(hook, value, …params)DiviAreaItem.addFilter(hook, callback, priority, context)DiviAreaItem.addAction(hook, callback, priority, context)DiviAreaItem.removeFilter(hook, callback)DiviAreaItem.removeAction(hook, callback)DiviAreaItem.addActionOnce(hook, callback, priority, context)DiviAreaItem.hasClass()DiviAreaItem.addClass()DiviAreaItem.removeClass()DiviAreaItem.attr()DiviAreaItem.removeAttr()DiviAreaItem.find()DiviAreaItem.css()