Kindly EditDocumentationTry the editor

editor.js

The main editing application: selection, inspector controls, content manipulation, history, responsive canvas, media and link dialogs, serialization, save coordination, and UI lifecycle.

Responsibility#

The main editing application: selection, inspector controls, content manipulation, history, responsive canvas, media and link dialogs, serialization, save coordination, and UI lifecycle.

File characteristics#

  • Source: assets/editor.js
  • Lines in this release: 16311
  • Type: browser JavaScript

Named browser helpers#

acceptsMove, acceptsNew, act, actionName, adaptiveItem, adaptiveNoun, addElement, addFirst, addItemAfter, addItemButton, addItemLike, addMenuLink, addPoint, addTabAfter, addTableColumn, addTableRow, addTile, adderWhere, addressCheck, addressPart, advancedPanel, alikeItem, alikeMark, allIcons, announce, announceCanvas, anyKindOf, api, apiError, apply, applyScreens, arrangeGroup, asSection, askConflict, askDelete, askExit, atPath, attempt, barName, basicsInto, beginContainerDrag, beginNewDrag, betweenBlocks, bgLayers, bgSaid, bind, blankPart, blockEl, blockKindOf, blockOps, blockPage, blockPanel, blockState, blockWords, boxAxis, boxName, boxPanel, branch, buildCode, builtBackground, buttonRowFor, buttonRowOf, candidates, canvasAnchor, canvasPoint, cap, captionControls, cardLine, caretLine, caretOffset, cellLine, cellName, cellOf, cellSpan, change, charsTo, checkH1s, checkNewer, checkedText, choiceItems, choicesPanel, chooseDevice, chooseMoveContainer, chooseOn, chosenU, clean, cleanAnchor, cleanIcon, clear, clearGrid, clipRead, clipWrite, closeAdder, closeBarPop, closeCtx, closeInspector, closeMenu, closeOutlinePane, closePicker, closePop, collapseButton, commit, commitButtonMove, commitContainerMove, commitNewDrop, componentFor, componentItem, componentName, componentOf, configuredSection, conflict, containerContents, containerDropAt, containerKey, containerLayout, contentRects, convertUnit, copyChanges, coversWords, crumbName, crumbs, cssNamed, currentTitle, decorativeDropLayer, defaultInsertPoint, designClassesGroup, designedSize, devArrangement, devChoices, devColour, devColumns, devFallback, devFourSides, devFunctions, devGradient, devMeasure, devMotion, devNumber, devOverlay, devPick, devPlacement, devPopup, devReset, devSelect, devShadow, devSize, devSpacing, devSpan, devSwitch, devText, developerInspector, developerResponsivePanel, developerStylePanel, developerTabs, deviceAt, deviceBar, deviceCanvasOn, deviceDecls, deviceKeeps, deviceMedia, deviceName, deviceRow, deviceWidthFor, dialog, directionOverride, dirtyRegions, discard, discardItem, dismissIntro, dismissPanel, docRowFor, dock, dragUnit, draw, drawBoxes, drawContainerDrop, drawDeviceSwitch, drawGapMarks, drawImage, drawInsertLine, drawPvStrip, drawSimple, drawStageHead, drawToolbar, drawnLines, drop, dropName, dsClass, dsCss, dsFromElement, dsImport, dsKey, dsKeyName, dsNewId, dsNewVariable, dsNotify, dsPut, dsSave, dsSend, dsSync, dsTake, dsVar, dsVarSaid, dsVarSelect, duplicate, dynamicE, edge, editSource, editorSheet, effectiveDisplay, elementAction, elementCatalog, elementChildren, elementCssPanel, elementCssRules, elementJsPanel, elementPhpPanel, elementSettingsGroup, elementTile, elementsPlace, elementsPlaceWords, embedPanel, emptyHolder, emptySection, emptyState, end, endContainerDrag, endRun, enterDevice, equalColumns, escape, escapeElementCss, escapeElementJs, exitEditor, exportTemplate, fail, fallbackWords, favouriteElements, fbtn, fetchTemplates, field, fieldPanel, fillTable, findAdaptiveItem, finishTyping, fit, fitBar, fitGridItems, fitSheet, fitVisual, fixedTone, flash, flatten, flexAxes, flexColumnsNow, flip, flipMove, flowAxes, fnList, focusBar, focusUrl, foldGroups, foldSummary, freeJumpName, freshIds, freshNonce, friendlyChoices, fromBlock, fromComponent, fromLive, gapHolder, gapHolders, gapKids, gapSpots, go, goToSection, gradientOf, gridAddSpot, gridAllowed, gridAround, gridBlockers, gridButton, gridColumns, gridColumnsOn, gridCountRow, gridGroup, gridItems, gridLinks, gridName, gridOutlineToggle, gridOwnOn, gridTracks, group, groupSummaries, h, hasBlockKids, hasSpokenOnly, headCheck, headFor, headerRow, headingOutline, headingSkips, hexOf, holdOpen, holderOK, htmlOnlyFrame, icon, iconComesFirst, iconGrid, iconPanel, iconTitle, iconWithLook, identity, identityNote, imagePanel, implicitColumns, inUI, inertCopy, inertFields, inheritedStyle, inheriting, inlineOf, inlineStyle, innerWrapper, insert, insertTemplate, installLiveStyles, introSeenHere, isButtonRow, isDev, isDirty, isFrontPage, isGrid, isGroup, isNewItem, isSample, isSection, isStyleRule, item, itemActions, itemGroup, itemNoun, itemOf, itemSiblings, itemWords, itemsControl, itemsInside, joinable, jumpName, kbStops, keep, keepBeforeLeaving, keepIconMeaning, keepStep, keptDraftAsk, keyWalk, kindName, kindOf, kindWidth, kindsFor, label, landOn, largerDevices, lastItemScope, layoutDevice, layoutName, layoutNow, layoutOf, layoutPanel, layoutParent, leadWords, leaveDevice, leaveSectionKeys, levelBefore, liftToasts, lineOf, lineOn, linkAddressFollows, linkBullet, linkLabel, linkName, linkPanel, linkWords, listItemIcon, listItemOf, listItemToParagraph, listItems, listKey, listOpen, listPanel, listed, liveInput, liveName, livePanel, load, loadComponents, loadPageList, loadTiles, local, locked, lockedPanel, lockedSay, loneComponentItem, lonePanelNote, lonePanelOf, lookThumb, loop, mainMenu, makeLandingSpot, makeSeamButton, managedClasses, markIntroSeen, markItems, markOutline, matchRule, matches, matchesSearch, meaningfulParent, measureHint, mediaCategories, mediaNote, mediaOpen, menuSpotButton, menuSpotFor, menuToggleFor, missingLinks, modal, moreFolds, moreRow, morph, move, moveContainerName, moveItem, moveSection, moveSpot, moveTableColumn, moveWhy, moveWords, nameTitle, named, narrowSimple, newCellLike, newPage, newTabItem, nextReal, normCss, normaliseHref, noteAfterReload, offWin, olSig, olStacks, onCanvasProxy, onDarkIfNeeded, onDoc, onWin, onlyTitleBand, openAddContent, openAdder, openChoices, openColours, openCtx, openDesignSystem, openDevGroup, openElements, openField, openFinder, openGlobals, openHistory, openInspector, openLink, openPicker, openPop, openPopupBox, openPopups, openScreens, openSeo, openStructure, openTemplateLibrary, orList, orderGroups, overrideReview, ownDecl, ownSettings, ownStyleOf, ownText, pageActive, pageAddress, pageFonts, pageLock, pageSections, pageSel, pageZoom, pagesChooser, paint, paintOf, paintSwatch, panelActions, panelMax, panelWidth, paragraphToList, parentRoute, parseCode, parseDecls, parseTableValues, partName, partNote, partsName, pasteCell, pasteDir, pasteDirection, pasteInto, pasteTable, pasteTag, pasteWalk, pathOf, payload, picUnit, pickFile, pickImage, pickOf, pictureBox, pictureSide, pictureSize, pictureWas, pieces, ping, place, placeAt, placeBarPop, placeCaretAfter, placeChip, placeCluster, placeGrips, placeListItemIcon, placeName, placePanel, placePop, placeToolbar, placeWords, placesFor, plainBlocks, plainClassWords, plainList, plainListItem, plainParts, pointAt, popItem, popupStatsLine, popupStatsWords, postTemplate, pressForReal, previewAt, previewBlocks, previewShot, previewSize, pruneHidden, publishAsk, publishFlow, pushUndo, putColumns, putPictureSize, putStyle, radioKeys, reachBottom, readKey, readPaste, redo, refind, refitRows, refresh, refreshAllLive, refreshLive, refreshPanelTemplates, remapRefs, remove, removeItem, removeSection, removeTableColumn, removeTableRow, rename, renumberLists, repeated, resetToSaved, responsiveCss, restore, restoreCaret, restoreParts, retitle, reveal, revealAboveSheet, revealInsertLine, reviewItems, reviewList, rootName, rootOf, roots, row, rowGrid, rowRun, runWords, safeValue, sameChoice, sameColour, sameLine, sameMovePosition, sampleWords, save, saveGlobal, saveTemplate, sayScope, screenSummary, seamButton, seams, searchAnswer, searchMatches, searchPages, searchScore, sectionChildren, sectionHost, sectionName, sectionOf, sectionSpacing, sectionTitle, select, selectGrid, selectWord, selectedLinks, selectionSpots, sendImport, setCaretOffset, setCellSpan, setCollapsed, setFavourite, setKind, setLinkLine, setLinkText, setListKind, setPageZoom, setPanelWidth, setPicture, setPreview, setScreens, shapeConflict, shapeFrame, shapeOf, sheetRoom, shortcuts, show, showChange, showChosen, showIntro, showPreview, showSeam, showUnfinished, shown, shownBox, siblingOK, siblingsOfKind, sideChoice, sideOf, simpleActions, simpleParent, simpleScopeTitle, simpleSectionBackground, simpleSections, simpleWalk, sizeBlocked, sizeCanvas, sizePreview, sizedBox, sketch, smallItem, snapshot, soloLink, sourceFor, sourcePanel, spanCount, specifiedColumns, splitMeasure, splitOrFinish, splitSelectors, spokenOnly, spreadAt, stackingAnchor, startInCell, startTyping, startVisitorRun, stateAttr, stateBar, stateDecls, stateName, statePreview, statusDetails, statusFor, statusText, stepAside, stepOf, stop, stopVisitorRun, stopped, stripInvisible, structural, structureCopy, structureDrag, structureInto, structureKids, structureMove, structureName, structureSpot, structureTools, styleChecks, styleMatches, styleOf, stylePanel, styleTargets, swapTag, switchFocus, syncElementCss, syncFmt, syncGridVar, syncResponsive, tabPair, tableCellActions, tableColumnProblem, tableMarkSpots, tablePanel, tableRowProblem, tableRows, tableRowsOf, tableValuesGroup, tableValuesProblem, tableValuesText, tableWidthOf, tabsInOrder, tbtn, techDetails, templateItem, templateKey, templatePage, templatesGroup, textColours, textNodeOf, textNodes, textPanel, themeColumns, themeE, themeRulesFor, themeRulesView, themeValue, thingName, throwAway, tile, tileColours, titleHelp, toTop, toast, toggleBarPop, toggleMenu, toggleUnderline, toneColour, toneContrast, toneOptions, tool, trackCount, tracksWords, trashPage, trialBox, txt, typable, typeReach, typingPart, uncertainFailure, underlineOn, undo, undoTo, unfinished, unfinishedItems, uniqueIds, unitOf, unitPx, unlineOnly, unpaint, unpublishedLinks, unsizePicture, unsizedForAMoment, updateCanvasChip, updateReview, vh, viewBottom, visibilityCss, visualOption, vw, wake, walk, whenNoDialog, whenWords, whereWords, wholeRows, widthTiles, windowDevice, withChoice, withDevice, withState, wordCell, words, wordsLined, wordsUnderPointer, wrap, write.

These functions are internal to the module unless an explicit public contract says otherwise. The list includes nested helpers and is not a global browser API.

Literal event listeners#

beforeunload, blur, change, click, dblclick, dragend, dragover, dragstart, drop, error, focus, focusin, focusout, input, keydown, kindly-edit:canvas, load, lostpointercapture, pagehide, pointercancel, pointerdown, pointerenter, pointerleave, pointermove, pointerup, resize, scroll, submit, toggle, visibilitychange. Dynamic event names may be assembled elsewhere. Event listeners must follow the owner document when the live device canvas moves page nodes.

Markup attributes used here#

data-cb-hover, data-cb-levels, data-cb-lightbox, data-cb-motion, data-cb-motion-delay, data-cb-motion-time, data-cb-pic, data-cb-sticky, data-ce-block, data-ce-bt, data-ce-closed, data-ce-component, data-ce-crumbs, data-ce-css, data-ce-device, data-ce-drag-src, data-ce-drop-empty, data-ce-drop-ph, data-ce-edit-hint, data-ce-edit-label, data-ce-edit-url, data-ce-item, data-ce-k, data-ce-lead, data-ce-live-status, data-ce-live-style, data-ce-lock, data-ce-manage-hint, data-ce-manage-label, data-ce-manage-url, data-ce-measuring, data-ce-opened, data-ce-part, data-ce-role, data-ce-root, data-ce-shortcode, data-ce-size-mark, data-ce-state, data-ce-ui, data-ke-css, data-ke-dyn, data-ke-focus, data-ke-global, data-ke-hover, data-ke-items, data-ke-js, data-ke-js-sig, data-ke-model, data-ke-name, data-ke-phone, data-ke-phone-focus, data-ke-phone-hover, data-ke-php, data-ke-popup, data-ke-popup-act, data-ke-popup-on, data-ke-popup-open, data-ke-tablet, data-ke-tablet-focus, data-ke-tablet-hover. These names can represent authored state, generated output, or temporary editor markers. Use the feature’s save contract before persisting them.

Integration and verification#

Load this file through the plugin’s normal enqueue path so its dependencies and configuration are present. Check the relevant feature after a saved reload, in the live device canvas where applicable, and on the published page. Editor-only UI should not become authored page content. See architecture for the lifecycle and responsive design for document movement.

About this page

Documents Kindly Edit 0.9.16. Source: assets/editor.js. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.