Class CodeCell

An object that can request something of the session.

Hierarchy (view full)

Implements

Other

constructor ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE PROCESSING_INSTRUCTION_NODE TEXT_NODE _config _disableSubmit? _feedback? _language? _status accessKey accessKeyLabel active activeLocatorRef activity activityRequested ariaAtomic ariaAutoComplete ariaBusy ariaChecked ariaColCount ariaColIndex ariaColSpan ariaCurrent ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot attemptFailed attemptFocus attributeStyleMap attributes autocapitalize autofocus baseURI childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth completionFocusPending completionRef connectButtonRef consumerId contentEditable dataset dir draggable editorRef enterKeyHint events executionBinding? executionKey? executionPresentation feedbackAnnouncement feedbackAreaRef feedbackUpdating firstChild firstElementChild handleError hidden highContrastMatcher? id inert innerHTML innerText inputMode interruptButtonRef interrupting interruptionGeneration isConnected isContentEditable keybindings lang lastChild lastElementChild localName log namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText outputAreaRef ownerDocument parentElement parentNode parsedKeyBindings part pendingAction? pendingFeedback? popover prefersHighContrast prefersReducedMotion prefix previousElementSibling previousSibling reducedMotionMatcher? resetButtonRef resultRef resultSummary role runButtonRef scrollHeight scrollLeft scrollTop scrollWidth session? sessionInteractor? shadowRoot slot solutionButtonRef spec spellcheck started startupAnnouncement startupWasAnnounced statusBarRef storage style submitButtonRef submitting suppressCompletionAnnouncement tabIndex tagName textContent title translate viewGeneration [metadata] _$litElement$ _initializers? finalized tag config disableSubmit editor feedback feedbackArea language languageName outputArea status statusBar storedCode storedFeedback storedOutput version activateAttempt addEventListener after animate append appendChild attachInternals attachShadow before beginOutputUpdate blur cancelFeedbackUpdate changeLanguage checkVisibility click cloneNode closest compareDocumentPosition computedStyleMap connect connectErrorHandler connectLogger connectSession connectStorage connectedCallback contains createRenderRoot disconnectedCallback dispatchEvent errorMessage finishOutputUpdate firstUpdated focus focusActive getAnimations getAttribute getAttributeNS getAttributeNames getAttributeNode getAttributeNodeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS getRootNode handleFeedback handleKernelStatusChange handleOutput handleServerStatusChange hasAttribute hasAttributeNS hasAttributes hasChildNodes hasPointerCapture hidePopover insertAdjacentElement insertAdjacentHTML insertAdjacentText insertBefore interrupt isDefaultNamespace isEqualNode isRunnable isSameNode isSubmittable loadFromStorage lookupNamespaceURI lookupPrefix matches normalize onHighContrastChange onReducedMotionChange onVisibilityChange prepend querySelector querySelectorAll releaseExecution releasePointerCapture remove removeAttribute removeAttributeNS removeAttributeNode removeChild removeEventListener render renderActiveLocator renderConnectButton renderEditor renderEditorControls renderExerciseId renderFeedbackArea renderFooter renderInterruptButton renderKernelLogo renderKernelLogoFor renderOutputArea renderResult renderRunButton renderSessionControls renderStatusBar renderStatusMessage renderSubmitButton replaceChild replaceChildren replaceWith requestFullscreen requestPointerLock reset revealActivity run scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNS setAttributeNode setAttributeNodeNS setPointerCapture showPopover solution storeResponse storedRun submit toggleAttribute togglePopover updateActivity webkitMatchesSelector willUpdate addInitializer extractSpecFromMarkdown finalize globalConfigure globalFromMarkdown loadDatasetAttributes

attributes

observedAttributes attributeChangedCallback

controllers

addController removeController

dev-mode

disableWarning? enableWarning? enabledWarnings?

properties

elementProperties properties createProperty getPropertyDescriptor getPropertyOptions

rendering

renderOptions renderRoot shadowRootOptions

styles

elementStyles styles? finalizeStyles

updates

hasUpdated isUpdatePending updateComplete enableUpdating getUpdateComplete performUpdate requestUpdate scheduleUpdate shouldUpdate update updated

Other

constructor

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: 6

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

Readonly NOTATION_NODE

NOTATION_NODE: 12

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: 3

node is a Text node.

Protected _config

_config: IDefaultConfig = ...

Protected Optional _disableSubmit

_disableSubmit?: boolean

Protected Optional _feedback

_feedback?: IFeedback

Protected Optional _language

_language?: KernelLanguage

Protected _status

_status: IStatus = ...

accessKey

accessKey: string

MDN Reference

Readonly accessKeyLabel

accessKeyLabel: string

MDN Reference

active

active: boolean = false

Whether the cell is currently up in the session queue.

Protected activeLocatorRef

activeLocatorRef: Ref<LitElement> = ...

Private Readonly activity

activity: ActivityPresentation = ...

Private activityRequested

activityRequested: boolean = false

ariaAtomic

ariaAtomic: string

MDN Reference

ariaAutoComplete

ariaAutoComplete: string

MDN Reference

ariaBusy

ariaBusy: string

MDN Reference

ariaChecked

ariaChecked: string

MDN Reference

ariaColCount

ariaColCount: string

MDN Reference

ariaColIndex

ariaColIndex: string

MDN Reference

ariaColSpan

ariaColSpan: string

MDN Reference

ariaCurrent

ariaCurrent: string

MDN Reference

ariaDisabled

ariaDisabled: string

MDN Reference

ariaExpanded

ariaExpanded: string

MDN Reference

ariaHasPopup

ariaHasPopup: string

MDN Reference

ariaHidden

ariaHidden: string

MDN Reference

ariaInvalid

ariaInvalid: string

ariaKeyShortcuts

ariaKeyShortcuts: string

MDN Reference

ariaLabel

ariaLabel: string

MDN Reference

ariaLevel

ariaLevel: string

MDN Reference

ariaLive

ariaLive: string

MDN Reference

ariaModal

ariaModal: string

MDN Reference

ariaMultiLine

ariaMultiLine: string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: string

MDN Reference

ariaOrientation

ariaOrientation: string

MDN Reference

ariaPlaceholder

ariaPlaceholder: string

MDN Reference

ariaPosInSet

ariaPosInSet: string

MDN Reference

ariaPressed

ariaPressed: string

MDN Reference

ariaReadOnly

ariaReadOnly: string

MDN Reference

ariaRequired

ariaRequired: string

MDN Reference

ariaRoleDescription

ariaRoleDescription: string

MDN Reference

ariaRowCount

ariaRowCount: string

MDN Reference

ariaRowIndex

ariaRowIndex: string

MDN Reference

ariaRowSpan

ariaRowSpan: string

MDN Reference

ariaSelected

ariaSelected: string

MDN Reference

ariaSetSize

ariaSetSize: string

MDN Reference

ariaSort

ariaSort: string

MDN Reference

ariaValueMax

ariaValueMax: string

MDN Reference

ariaValueMin

ariaValueMin: string

MDN Reference

ariaValueNow

ariaValueNow: string

MDN Reference

ariaValueText

ariaValueText: string

MDN Reference

Readonly assignedSlot

assignedSlot: HTMLSlotElement

MDN Reference

Private attemptFailed

attemptFailed: boolean = false

Private Readonly attemptFocus

attemptFocus: AttemptFocus = ...

Readonly attributeStyleMap

attributeStyleMap: StylePropertyMap

Readonly attributes

attributes: NamedNodeMap

MDN Reference

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

Readonly baseURI

baseURI: string

Returns node's node document's document base URL.

MDN Reference

Readonly childElementCount

childElementCount: number

MDN Reference

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

Readonly children

children: HTMLCollection

Returns the child elements.

MDN Reference

Readonly classList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

Readonly clientHeight

clientHeight: number

MDN Reference

Readonly clientLeft

clientLeft: number

MDN Reference

Readonly clientTop

clientTop: number

MDN Reference

Readonly clientWidth

clientWidth: number

MDN Reference

Private completionFocusPending

completionFocusPending: boolean = false

Private Readonly completionRef

completionRef: Ref<HTMLElement> = ...

Protected connectButtonRef

connectButtonRef: Ref<LitElement> = ...

Private Readonly consumerId

consumerId: string = ...

contentEditable

contentEditable: string

MDN Reference

Readonly dataset

dataset: DOMStringMap

MDN Reference

dir

dir: string

MDN Reference

draggable

draggable: boolean

MDN Reference

Protected editorRef

editorRef: Ref<IEditor> = ...

enterKeyHint

enterKeyHint: string

MDN Reference

Protected events

events: {
    feedback: EventEmitter<IFeedbackPayload>;
    reset: EventEmitter<IResetPayload>;
    run: EventEmitter<IRunPayload>;
    solution: EventEmitter<ISolutionPayload>;
    start: EventEmitter<IStartPayload>;
    submit: EventEmitter<ISubmitPayload>;
} = ...

Events emitted by the cell when the user performs an action.

Type declaration

Private Optional executionBinding

executionBinding?: {
    interactor: ISessionInteractor;
    release: (() => void);
    session: CellSessionState;
}

Type declaration

Private Optional executionKey

executionKey?: string

Private Readonly executionPresentation

executionPresentation: ExecutionPresentation = ...

Private feedbackAnnouncement

feedbackAnnouncement: string = ""

Protected feedbackAreaRef

feedbackAreaRef: Ref<IFeedbackArea> = ...

Private feedbackUpdating

feedbackUpdating: boolean = false

Readonly firstChild

firstChild: ChildNode

Returns the first child.

MDN Reference

Readonly firstElementChild

firstElementChild: Element

Returns the first child that is an element, and null otherwise.

MDN Reference

Protected handleError

handleError: IErrorHandler

hidden

hidden: boolean

MDN Reference

Private Optional highContrastMatcher

highContrastMatcher?: MediaQueryList

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

inert

inert: boolean

MDN Reference

innerHTML

innerHTML: string

MDN Reference

innerText

innerText: string

MDN Reference

inputMode

inputMode: string

MDN Reference

Protected interruptButtonRef

interruptButtonRef: Ref<MdFilledTonalButton> = ...

interrupting

interrupting: boolean = false

Private interruptionGeneration

interruptionGeneration: number = 0

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

Readonly isContentEditable

isContentEditable: boolean

MDN Reference

keybindings

keybindings: IKeyBinding[] = ...

Registered hotkeys for the cell's user actions.

lang

lang: string

MDN Reference

Readonly lastChild

lastChild: ChildNode

Returns the last child.

MDN Reference

Readonly lastElementChild

lastElementChild: Element

Returns the last child that is an element, and null otherwise.

MDN Reference

Readonly localName

localName: string

Returns the local name.

MDN Reference

Protected log

log: ILogger

Setup the cell's logger.

Readonly namespaceURI

namespaceURI: string

Returns the namespace.

MDN Reference

Readonly nextElementSibling

nextElementSibling: Element

Returns the first following sibling that is an element, and null otherwise.

MDN Reference

Readonly nextSibling

nextSibling: ChildNode

Returns the next sibling.

MDN Reference

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

Readonly nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: string

MDN Reference

Optional nonce

nonce?: string

MDN Reference

Readonly offsetHeight

offsetHeight: number

MDN Reference

Readonly offsetLeft

offsetLeft: number

MDN Reference

Readonly offsetParent

offsetParent: Element

MDN Reference

Readonly offsetTop

offsetTop: number

MDN Reference

Readonly offsetWidth

offsetWidth: number

MDN Reference

onabort

onabort: ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onanimationcancel

onanimationcancel: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend

onanimationend: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration

onanimationiteration: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart

onanimationstart: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick

onauxclick: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput

onbeforeinput: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onblur

onblur: ((this, ev) => any)

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

        MDN Reference

      Returns any

oncancel

oncancel: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay

oncanplay: ((this, ev) => any)

Occurs when playback is possible, but would require further buffering.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

oncanplaythrough

oncanplaythrough: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange

onchange: ((this, ev) => any)

Fires when the contents of the object or selection have changed.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onclick

onclick: ((this, ev) => any)

Fires when the user clicks the left mouse button on the object

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onclose

onclose: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu

oncontextmenu: ((this, ev) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

oncopy

oncopy: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange

oncuechange: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut

oncut: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick

ondblclick: ((this, ev) => any)

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

ondrag

ondrag: ((this, ev) => any)

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ondragend

ondragend: ((this, ev) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ondragenter

ondragenter: ((this, ev) => any)

Fires on the target element when the user drags the object to a valid drop target.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragleave

ondragleave: ((this, ev) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragover

ondragover: ((this, ev) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ondragstart

ondragstart: ((this, ev) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ondrop

ondrop: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange

ondurationchange: ((this, ev) => any)

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onemptied

onemptied: ((this, ev) => any)

Occurs when the media element is reset to its initial state.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onended

onended: ((this, ev) => any)

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onerror

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus

onfocus: ((this, ev) => any)

Fires when the object receives focus.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onformdata

onformdata: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

onfullscreenchange

onfullscreenchange: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror

onfullscreenerror: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: Element
      • ev: Event

      Returns any

ongotpointercapture

ongotpointercapture: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput

oninput: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid

oninvalid: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown

onkeydown: ((this, ev) => any)

Fires when the user presses a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onkeypress

onkeypress: ((this, ev) => any)

Fires when the user presses an alphanumeric key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

Deprecated

MDN Reference

onkeyup

onkeyup: ((this, ev) => any)

Fires when the user releases a key.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onload

onload: ((this, ev) => any)

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onloadeddata

onloadeddata: ((this, ev) => any)

Occurs when media data is loaded at the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onloadedmetadata

onloadedmetadata: ((this, ev) => any)

Occurs when the duration and dimensions of the media have been determined.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onloadstart

onloadstart: ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onlostpointercapture

onlostpointercapture: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown

onmousedown: ((this, ev) => any)

Fires when the user clicks the object with either mouse button.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseenter

onmouseenter: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave

onmouseleave: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove

onmousemove: ((this, ev) => any)

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseout

onmouseout: ((this, ev) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseover

onmouseover: ((this, ev) => any)

Fires when the user moves the mouse pointer into the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseup

onmouseup: ((this, ev) => any)

Fires when the user releases a mouse button while the mouse is over the object.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onpaste

onpaste: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause

onpause: ((this, ev) => any)

Occurs when playback is paused.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onplay

onplay: ((this, ev) => any)

Occurs when the play method is requested.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onplaying

onplaying: ((this, ev) => any)

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onpointercancel

onpointercancel: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown

onpointerdown: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter

onpointerenter: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave

onpointerleave: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove

onpointermove: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout

onpointerout: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover

onpointerover: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup

onpointerup: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress

onprogress: ((this, ev) => any)

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

        MDN Reference

      Returns any

onratechange

onratechange: ((this, ev) => any)

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onreset

onreset: ((this, ev) => any)

Fires when the user resets a form.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onresize

onresize: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll

onscroll: ((this, ev) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onscrollend

onscrollend: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onsecuritypolicyviolation

onsecuritypolicyviolation: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked

onseeked: ((this, ev) => any)

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onseeking

onseeking: ((this, ev) => any)

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onselect

onselect: ((this, ev) => any)

Fires when the current selection changes.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onselectionchange

onselectionchange: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart

onselectstart: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange

onslotchange: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled

onstalled: ((this, ev) => any)

Occurs when the download has stopped.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onsubmit

onsubmit: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend

onsuspend: ((this, ev) => any)

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ontimeupdate

ontimeupdate: ((this, ev) => any)

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

ontoggle

ontoggle: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Optional ontouchcancel

ontouchcancel?: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchend

ontouchend?: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchmove

ontouchmove?: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

Optional ontouchstart

ontouchstart?: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel

ontransitioncancel: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend

ontransitionend: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun

ontransitionrun: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart

ontransitionstart: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange

onvolumechange: ((this, ev) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onwaiting

onwaiting: ((this, ev) => any)

Occurs when playback stops because the next frame of a video resource is not available.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onwebkitanimationend

onwebkitanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

onwebkitanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

onwebkitanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

onwebkittransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

onwheel: ((this, ev) => any)

MDN Reference

Type declaration

    • (this, ev): any

    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML

outerHTML: string

MDN Reference

outerText

outerText: string

MDN Reference

Protected outputAreaRef

outputAreaRef: Ref<IOutputArea> = ...

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: HTMLElement

Returns the parent element.

MDN Reference

Readonly parentNode

parentNode: ParentNode

Returns the parent.

MDN Reference

Protected parsedKeyBindings

parsedKeyBindings: IParsedKeyBinding[]

Readonly part

part: DOMTokenList

MDN Reference

Private Optional pendingAction

pendingAction?: "run" | "submit"

Private Optional pendingFeedback

pendingFeedback?: IFeedback

popover

popover: string

MDN Reference

Protected prefersHighContrast

prefersHighContrast: boolean = false

Private prefersReducedMotion

prefersReducedMotion: boolean = false

Readonly prefix

prefix: string

Returns the namespace prefix.

MDN Reference

Readonly previousElementSibling

previousElementSibling: Element

Returns the first preceding sibling that is an element, and null otherwise.

MDN Reference

Readonly previousSibling

previousSibling: ChildNode

Returns the previous sibling.

MDN Reference

Private Optional reducedMotionMatcher

reducedMotionMatcher?: MediaQueryList

Protected resetButtonRef

resetButtonRef: Ref<MdFilledTonalButton> = ...

Private Readonly resultRef

resultRef: Ref<HTMLElement> = ...

Private resultSummary

resultSummary: string = ""

role

role: string

Protected runButtonRef

runButtonRef: Ref<LitElement> = ...

Readonly scrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

Readonly scrollWidth

scrollWidth: number

MDN Reference

Optional session

session?: CellSessionState

The cell's session (shared across cells), if one has been configured.

Optional sessionInteractor

sessionInteractor?: ISessionInteractor

Readonly shadowRoot

shadowRoot: ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

Protected solutionButtonRef

solutionButtonRef: Ref<MdFilledTonalButton> = ...

Protected spec

spec: IExerciseSpec = {}

spellcheck

spellcheck: boolean

MDN Reference

Protected started

started: boolean = false

Private startupAnnouncement

startupAnnouncement: string = ""

Private startupWasAnnounced

startupWasAnnounced: boolean = false

Protected statusBarRef

statusBarRef: Ref<MdLinearProgress> = ...

storage

storage: IStorage<Storable>

Setup the cell's storage.

Readonly style

style: CSSStyleDeclaration

MDN Reference

Protected submitButtonRef

submitButtonRef: Ref<LitElement> = ...

submitting

submitting: boolean = false

Private suppressCompletionAnnouncement

suppressCompletionAnnouncement: boolean = false

tabIndex

tabIndex: number

MDN Reference

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

textContent

textContent: string

MDN Reference

title

title: string

MDN Reference

translate

translate: boolean

Private viewGeneration

viewGeneration: number = 0

Static [metadata]

[metadata]: object & Record<PropertyKey, unknown>

Static _$litElement$

_$litElement$: boolean

Static Optional _initializers

_initializers?: Initializer[]

Static Protected finalized

finalized: true

Marks class as having been finalized, which includes creating properties from static properties, but does not include all properties created from decorators.

Nocollapse

Static tag

tag: string = "code-cell"

config

  • get config(): IDefaultConfig

  • The cell's configuration (may be partial, and partials are validated on demand).

    This does not override any configurations that can be set via cell properties. For example, if you set config.session.language to "python" here, but then specify a cell like <ck-code-cell language="r">, the cell will use R as the language.

    Returns IDefaultConfig

  • set config(config): void

  • The cell's configuration (may be partial, and partials are validated on demand).

    This does not override any configurations that can be set via cell properties. For example, if you set config.session.language to "python" here, but then specify a cell like <ck-code-cell language="r">, the cell will use R as the language.

    Parameters

    • config: PartialObjectDeep<IConfig, {}>

    Returns void

disableSubmit

editor

feedback

feedbackArea

language

Private languageName

outputArea

status

statusBar

storedCode

storedFeedback

storedOutput

version

Private activateAttempt

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

after

  • after(...nodes): void

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

animate

  • animate(keyframes, options?): Animation

  • MDN Reference

    Parameters

    • keyframes: Keyframe[] | PropertyIndexedKeyframes
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes): void

  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • appendChild<T>(node): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

attachInternals

  • attachInternals(): ElementInternals

  • MDN Reference

    Returns ElementInternals

attachShadow

  • attachShadow(init): ShadowRoot

  • Creates a shadow root for element and returns it.

    MDN Reference

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

before

  • before(...nodes): void

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

Private beginOutputUpdate

blur

  • blur(): void

  • MDN Reference

    Returns void

Private cancelFeedbackUpdate

Protected changeLanguage

checkVisibility

  • checkVisibility(options?): boolean

  • Parameters

    • Optional options: CheckVisibilityOptions

    Returns boolean

click

  • click(): void

  • MDN Reference

    Returns void

cloneNode

  • cloneNode(deep?): Node

  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    MDN Reference

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • closest<K>(selector): HTMLElementTagNameMap[K]

  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K]

  • closest<K>(selector): SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • closest<K>(selector): MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns MathMLElementTagNameMap[K]

  • closest<E>(selectors): E

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

compareDocumentPosition

  • compareDocumentPosition(other): number

  • Returns a bitmask indicating the position of other relative to node.

    MDN Reference

    Parameters

    • other: Node

    Returns number

computedStyleMap

  • computedStyleMap(): StylePropertyMapReadOnly

  • MDN Reference

    Returns StylePropertyMapReadOnly

connect

Protected connectErrorHandler

Protected connectLogger

Protected connectSession

Protected connectStorage

connectedCallback

contains

  • contains(other): boolean

  • Returns true if other is an inclusive descendant of node, and false otherwise.

    MDN Reference

    Parameters

    • other: Node

    Returns boolean

Protected createRenderRoot

disconnectedCallback

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

Protected errorMessage

Private finishOutputUpdate

Protected firstUpdated

  • firstUpdated(_changedProperties): void

  • Parameters

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

    Returns void

focus

  • focus(options?): void

  • MDN Reference

    Parameters

    • Optional options: FocusOptions

    Returns void

focusActive

getAnimations

  • getAnimations(options?): Animation[]

  • MDN Reference

    Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName): string

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns string

getAttributeNS

  • getAttributeNS(namespace, localName): string

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns string

getAttributeNames

  • getAttributeNames(): string[]

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    MDN Reference

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName): Attr

  • MDN Reference

    Parameters

    • qualifiedName: string

    Returns Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace, localName): Attr

  • MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns Attr

getBoundingClientRect

getClientRects

  • getClientRects(): DOMRectList

  • MDN Reference

    Returns DOMRectList

getElementsByClassName

  • getElementsByClassName(classNames): HTMLCollectionOf<Element>

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

  • MDN Reference

    Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    MDN Reference

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

Protected handleFeedback

Protected handleKernelStatusChange

Protected handleOutput

Protected handleServerStatusChange

hasAttribute

  • hasAttribute(qualifiedName): boolean

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace, localName): boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

  • Returns true if element has attributes, and false otherwise.

    MDN Reference

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    MDN Reference

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId): boolean

  • MDN Reference

    Parameters

    • pointerId: number

    Returns boolean

hidePopover

  • hidePopover(): void

  • MDN Reference

    Returns void

insertAdjacentElement

  • insertAdjacentElement(where, element): Element

  • MDN Reference

    Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

insertAdjacentHTML

  • insertAdjacentHTML(position, text): void

  • MDN Reference

    Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where, data): void

  • MDN Reference

    Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

  • insertBefore<T>(node, child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: Node

    Returns T

interrupt

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • MDN Reference

    Parameters

    • namespace: string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: Node

    Returns boolean

Protected isRunnable

isSameNode

  • isSameNode(otherNode): boolean

  • MDN Reference

    Parameters

    • otherNode: Node

    Returns boolean

Protected isSubmittable

  • isSubmittable(): this is CodeCell & Runnable & {
        _code: {
            test: string;
        };
        config: {
            editor: {
                disableSubmit: false;
            };
        };
        feedbackArea: IFeedbackArea;
    }

  • Whether the cell is submittable.

    Returns this is CodeCell & Runnable & {
        _code: {
            test: string;
        };
        config: {
            editor: {
                disableSubmit: false;
            };
        };
        feedbackArea: IFeedbackArea;
    }

    Note

    This is only a function because accessors cannot be typeguards.

loadFromStorage

lookupNamespaceURI

  • lookupNamespaceURI(prefix): string

  • MDN Reference

    Parameters

    • prefix: string

    Returns string

lookupPrefix

  • lookupPrefix(namespace): string

  • MDN Reference

    Parameters

    • namespace: string

    Returns string

matches

  • matches(selectors): boolean

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    MDN Reference

    Returns void

Private Readonly onHighContrastChange

Private Readonly onReducedMotionChange

Private Readonly onVisibilityChange

prepend

  • prepend(...nodes): void

  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

querySelector

  • querySelector<K>(selectors): HTMLElementTagNameMap[K]

  • Returns the first element that is a descendant of node that matches selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K]

  • querySelector<K>(selectors): SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • querySelector<K>(selectors): MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns MathMLElementTagNameMap[K]

  • querySelector<K>(selectors): HTMLElementDeprecatedTagNameMap[K]

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementDeprecatedTagNameMap[K]

    Deprecated

  • querySelector<E>(selectors): E

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

querySelectorAll

  • querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

  • Returns all element descendants of node that match selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • querySelectorAll<E>(selectors): NodeListOf<E>

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

Private releaseExecution

releasePointerCapture

  • releasePointerCapture(pointerId): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    MDN Reference

    Returns void

removeAttribute

  • removeAttribute(qualifiedName): void

  • Removes element's first attribute whose qualified name is qualifiedName.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace, localName): void

  • Removes element's attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr): Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

render

Protected renderActiveLocator

Protected renderConnectButton

Protected renderEditor

Protected renderEditorControls

Protected renderExerciseId

Protected renderFeedbackArea

Protected renderFooter

Protected renderInterruptButton

Protected renderKernelLogo

Protected renderKernelLogoFor

Protected renderOutputArea

Protected renderResult

Protected renderRunButton

Protected renderSessionControls

Protected renderStatusBar

Protected renderStatusMessage

Protected renderSubmitButton

replaceChild

  • replaceChild<T>(node, child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes): void

  • Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

replaceWith

  • replaceWith(...nodes): void

  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

requestFullscreen

  • requestFullscreen(options?): Promise<void>

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    MDN Reference

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

reset

Private Readonly revealActivity

run

scroll

  • scroll(options?): void

  • MDN Reference

    Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • MDN Reference

    Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?): void

  • MDN Reference

    Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?): void

  • MDN Reference

    Parameters

    • Optional options: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName, value): void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    MDN Reference

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace, qualifiedName, value): void

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    MDN Reference

    Parameters

    • namespace: string
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr): Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr): Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns Attr

setPointerCapture

  • setPointerCapture(pointerId): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

showPopover

  • showPopover(): void

  • MDN Reference

    Returns void

solution

Protected storeResponse

Protected storedRun

submit

toggleAttribute

  • toggleAttribute(qualifiedName, force?): boolean

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

togglePopover

  • togglePopover(force?): void

  • MDN Reference

    Parameters

    • Optional force: boolean

    Returns void

Private updateActivity

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

Protected willUpdate

Static addInitializer

  • addInitializer(initializer): void

  • Adds an initializer function to the class that is called during instance construction.

    This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.

    const myDecorator = (target: typeof ReactiveElement, key: string) => {
      target.addInitializer((instance: ReactiveElement) => {
        // This is run during construction of the element
        new MyController(instance);
      });
    }

    Decorating a field will then cause each instance to run an initializer that adds a controller:

    class MyElement extends LitElement {
      @myDecorator foo;
    }

    Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.

    Parameters

    • initializer: Initializer

    Returns void

    Nocollapse

Static extractSpecFromMarkdown

Static Protected finalize

  • finalize(): void

  • Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.

    This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.

    Returns void

    Nocollapse

Static globalConfigure

  • globalConfigure(partialConfig, watch?, withReload?): void

  • Set a new default configuration for all cells on a page.

    Applies the given configuration to every cell on the page by settings ICodeCell.config. If the watch parameter is true, the configuration will also be applied to any new cells that are created after the function is called.

    Parameters

    • partialConfig: PartialObjectDeep<IDefaultConfig, {}>

      the new default configuration (will be merged with defaults)

    • watch: boolean = false

      whether to watch for new cells and apply the configuration to them

    • withReload: boolean = true

      whether to reload the cells from storage after applying the configuration

    Returns void

Static globalFromMarkdown

  • globalFromMarkdown(selector?): void

  • Convert all matching source elements to CodeCells (see ()).

    To make code cells more readable in markdown files, you can specify them using fenced code blocks. These render to HTML as <pre><code> CONTENT </code></pre> where the content can then be processed by this function. The content should have a separate header for each kind of code you want to initialize the cell with (IExerciseSpec). Here is an example specification:

    ```{ #cell-id data-code-cell=true }
    %%% setup
    library(coursekata)

    %%% prompt
    # this gets shown when the cell is first loaded or when you press Reset
    ```

    Note that the headers for setup and prompt are preceded by %%% and that the top fence has braces ({}) to give the cell an ID and to indicate that it is a code cell. This code block will be parsed to this by most markdown renderers (some might put the attributes on the code tag instead of the pre tag, like markdown-it):

    <pre id="cell-id" data-code-cell="true">
      <code>
        %%% setup
        library(coursekata)

        %%% prompt
        # this gets shown when the cell is first loaded or when you press Reset
      </code>
    </pre>

    Finally, this method will read that rendered markdown and replace it with the appropriate <code-cell>:

    <code-cell id="cell-id">
      <code data-type="setup">
        library(coursekata)
      </code>
      <code data-type="prompt">
        # this gets shown when the cell is first loaded or when you press Reset
      </code>
    </code-cell>

    Parameters

    • selector: string = "[data-ckcode]"

      the CSS selector for the <pre> tags to read from. The easiest way to ensure that the CSS selector is unique to <code-cell> specifications is to give them all a data- attribute like data-code-cell=true.

    Returns void

Static Private loadDatasetAttributes

attributes

Static observedAttributes

  • get observedAttributes(): string[]

  • Returns a list of attributes corresponding to the registered properties.

    Returns string[]

    Nocollapse

attributeChangedCallback

  • attributeChangedCallback(name, _old, value): void

  • Synchronizes property values when attributes change.

    Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.

    See using the lifecycle callbacks on MDN for more information about the attributeChangedCallback.

    Parameters

    • name: string
    • _old: string
    • value: string

    Returns void

controllers

addController

  • addController(controller): void

  • Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.

    If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.

    Parameters

    • controller: ReactiveController

    Returns void

removeController

  • removeController(controller): void

  • Removes a ReactiveController from the element.

    Parameters

    • controller: ReactiveController

    Returns void

dev-mode

Static Optional disableWarning

disableWarning?: ((warningKind) => void)

Disable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');

// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');

Type declaration

    • (warningKind): void

    • Parameters

      • warningKind: WarningKind

      Returns void

Nocollapse

Static Optional enableWarning

enableWarning?: ((warningKind) => void)

Enable the given warning category for this class.

This method only exists in development builds, so it should be accessed with a guard like:

// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');

// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');

Type declaration

    • (warningKind): void

    • Parameters

      • warningKind: WarningKind

      Returns void

Nocollapse

Static Optional enabledWarnings

enabledWarnings?: WarningKind[]

Read or set all the enabled warning categories for this class.

This property is only used in development builds.

Nocollapse

properties

Static elementProperties

elementProperties: PropertyDeclarationMap

Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.

Nocollapse

Static properties

properties: PropertyDeclarations

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

Nocollapse

Static createProperty

  • createProperty(name, options?): void

  • Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.

    This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:

    static createProperty(name, options) {
      options = Object.assign(options, {myOption: true});
      super.createProperty(name, options);
    }

    Parameters

    • name: PropertyKey
    • Optional options: PropertyDeclaration<unknown, unknown>

    Returns void

    Nocollapse

Static Protected getPropertyDescriptor

  • getPropertyDescriptor(name, key, options): PropertyDescriptor

  • Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,

    class MyElement extends LitElement {
      static getPropertyDescriptor(name, key, options) {
        const defaultDescriptor =
            super.getPropertyDescriptor(name, key, options);
        const setter = defaultDescriptor.set;
        return {
          get: defaultDescriptor.get,
          set(value) {
            setter.call(this, value);
            // custom action.
          },
          configurable: true,
          enumerable: true
        }
      }
    }

    Parameters

    • name: PropertyKey
    • key: string | symbol
    • options: PropertyDeclaration<unknown, unknown>

    Returns PropertyDescriptor

    Nocollapse

Static getPropertyOptions

  • getPropertyOptions(name): PropertyDeclaration<unknown, unknown>

  • Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).

    Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.

    Parameters

    • name: PropertyKey

    Returns PropertyDeclaration<unknown, unknown>

    Nocollapse

    Final

rendering

Readonly renderOptions

renderOptions: RenderOptions

Readonly renderRoot

renderRoot: HTMLElement | DocumentFragment

Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.

Static shadowRootOptions

shadowRootOptions: ShadowRootInit

Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

Nocollapse

styles

Static elementStyles

elementStyles: CSSResultOrNative[]

Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.

Nocollapse

Static Optional styles

styles?: CSSResultGroup

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Static Protected finalizeStyles

  • finalizeStyles(styles?): CSSResultOrNative[]

  • Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

    Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

    Parameters

    • Optional styles: CSSResultGroup

    Returns CSSResultOrNative[]

    Nocollapse

updates

hasUpdated

hasUpdated: boolean

Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.

isUpdatePending

isUpdatePending: boolean

True if there is a pending update as a result of calling requestUpdate(). Should only be read.

updateComplete

  • get updateComplete(): Promise<boolean>

  • Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.

    To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.

    Returns Promise<boolean>

    A promise of a boolean that resolves to true if the update completed without triggering another update.

Protected enableUpdating

  • enableUpdating(_requestedUpdate): void

  • Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.

    Parameters

    • _requestedUpdate: boolean

    Returns void

Protected getUpdateComplete

  • getUpdateComplete(): Promise<boolean>

  • Override point for the updateComplete promise.

    It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:

    class MyElement extends LitElement {
      override async getUpdateComplete() {
        const result = await super.getUpdateComplete();
        await this._myChild.updateComplete;
        return result;
      }
    }

    Returns Promise<boolean>

    A promise of a boolean that resolves to true if the update completed without triggering another update.

Protected performUpdate

  • performUpdate(): void

  • Performs an element update. Note, if an exception is thrown during the update, firstUpdated and updated will not be called.

    Call performUpdate() to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.

    Returns void

requestUpdate

  • requestUpdate(name?, oldValue?, options?): void

  • Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored.

    Parameters

    • Optional name: PropertyKey

      name of requesting property

    • Optional oldValue: unknown

      old value of requesting property

    • Optional options: PropertyDeclaration<unknown, unknown>

      property options to use instead of the previously configured options

    Returns void

Protected scheduleUpdate

  • scheduleUpdate(): void | Promise<unknown>

  • Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.

    For instance, to schedule updates to occur just before the next frame:

    override protected async scheduleUpdate(): Promise<unknown> {
      await new Promise((resolve) => requestAnimationFrame(() => resolve()));
      super.scheduleUpdate();
    }

    Returns void | Promise<unknown>

Protected shouldUpdate

  • shouldUpdate(_changedProperties): boolean

  • Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.

    Parameters

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns boolean

Protected update

  • update(changedProperties): void

  • Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

    Parameters

    • changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns void

Protected updated

  • updated(_changedProperties): void

  • Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

    Setting properties inside this method will trigger the element to update again after this update cycle completes.

    Parameters

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorATTRIBUTE_NODECDATA_SECTION_NODECOMMENT_NODEDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_NODEENTITY_REFERENCE_NODENOTATION_NODEPROCESSING_INSTRUCTION_NODETEXT_NODE_config_disableSubmit_feedback_language_statusaccessKeyaccessKeyLabelactiveactiveLocatorRefactivityactivityRequestedariaAtomicariaAutoCompleteariaBusyariaCheckedariaColCountariaColIndexariaColSpanariaCurrentariaDisabledariaExpandedariaHasPopupariaHiddenariaInvalidariaKeyShortcutsariaLabelariaLevelariaLiveariaModalariaMultiLineariaMultiSelectableariaOrientationariaPlaceholderariaPosInSetariaPressedariaReadOnlyariaRequiredariaRoleDescriptionariaRowCountariaRowIndexariaRowSpanariaSelectedariaSetSizeariaSortariaValueMaxariaValueMinariaValueNowariaValueTextassignedSlotattemptFailedattemptFocusattributeStyleMapattributesautocapitalizeautofocusbaseURIchildElementCountchildNodeschildrenclassListclassNameclientHeightclientLeftclientTopclientWidthcompletionFocusPendingcompletionRefconnectButtonRefconsumerIdcontentEditabledatasetdirdraggableeditorRefenterKeyHinteventsexecutionBindingexecutionKeyexecutionPresentationfeedbackAnnouncementfeedbackAreaReffeedbackUpdatingfirstChildfirstElementChildhandleErrorhiddenhighContrastMatcheridinertinnerHTMLinnerTextinputModeinterruptButtonRefinterruptinginterruptionGenerationisConnectedisContentEditablekeybindingslanglastChildlastElementChildlocalNamelognamespaceURInextElementSiblingnextSiblingnodeNamenodeTypenodeValuenonceoffsetHeightoffsetLeftoffsetParentoffsetTopoffsetWidthonabortonanimationcancelonanimationendonanimationiterationonanimationstartonauxclickonbeforeinputonbluroncanceloncanplayoncanplaythroughonchangeonclickoncloseoncontextmenuoncopyoncuechangeoncutondblclickondragondragendondragenterondragleaveondragoverondragstartondropondurationchangeonemptiedonendedonerroronfocusonformdataonfullscreenchangeonfullscreenerrorongotpointercaptureoninputoninvalidonkeydownonkeypressonkeyuponloadonloadeddataonloadedmetadataonloadstartonlostpointercaptureonmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponpasteonpauseonplayonplayingonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointeruponprogressonratechangeonresetonresizeonscrollonscrollendonsecuritypolicyviolationonseekedonseekingonselectonselectionchangeonselectstartonslotchangeonstalledonsubmitonsuspendontimeupdateontoggleontouchcancelontouchendontouchmoveontouchstartontransitioncancelontransitionendontransitionrunontransitionstartonvolumechangeonwaitingonwebkitanimationendonwebkitanimationiterationonwebkitanimationstartonwebkittransitionendonwheelouterHTMLouterTextoutputAreaRefownerDocumentparentElementparentNodeparsedKeyBindingspartpendingActionpendingFeedbackpopoverprefersHighContrastprefersReducedMotionprefixpreviousElementSiblingpreviousSiblingreducedMotionMatcherresetButtonRefresultRefresultSummaryrolerunButtonRefscrollHeightscrollLeftscrollTopscrollWidthsessionsessionInteractorshadowRootslotsolutionButtonRefspecspellcheckstartedstartupAnnouncementstartupWasAnnouncedstatusBarRefstoragestylesubmitButtonRefsubmittingsuppressCompletionAnnouncementtabIndextagNametextContenttitletranslateviewGeneration[metadata]_$litElement$_initializersfinalizedtagconfigdisableSubmiteditorfeedbackfeedbackArealanguagelanguageNameoutputAreastatusstatusBarstoredCodestoredFeedbackstoredOutputversionactivateAttemptaddEventListenerafteranimateappendappendChildattachInternalsattachShadowbeforebeginOutputUpdateblurcancelFeedbackUpdatechangeLanguagecheckVisibilityclickcloneNodeclosestcompareDocumentPositioncomputedStyleMapconnectconnectErrorHandlerconnectLoggerconnectSessionconnectStorageconnectedCallbackcontainscreateRenderRootdisconnectedCallbackdispatchEventerrorMessagefinishOutputUpdatefirstUpdatedfocusfocusActivegetAnimationsgetAttributegetAttributeNSgetAttributeNamesgetAttributeNodegetAttributeNodeNSgetBoundingClientRectgetClientRectsgetElementsByClassNamegetElementsByTagNamegetElementsByTagNameNSgetRootNodehandleFeedbackhandleKernelStatusChangehandleOutputhandleServerStatusChangehasAttributehasAttributeNShasAttributeshasChildNodeshasPointerCapturehidePopoverinsertAdjacentElementinsertAdjacentHTMLinsertAdjacentTextinsertBeforeinterruptisDefaultNamespaceisEqualNodeisRunnableisSameNodeisSubmittableloadFromStoragelookupNamespaceURIlookupPrefixmatchesnormalizeonHighContrastChangeonReducedMotionChangeonVisibilityChangeprependquerySelectorquerySelectorAllreleaseExecutionreleasePointerCaptureremoveremoveAttributeremoveAttributeNSremoveAttributeNoderemoveChildremoveEventListenerrenderrenderActiveLocatorrenderConnectButtonrenderEditorrenderEditorControlsrenderExerciseIdrenderFeedbackArearenderFooterrenderInterruptButtonrenderKernelLogorenderKernelLogoForrenderOutputArearenderResultrenderRunButtonrenderSessionControlsrenderStatusBarrenderStatusMessagerenderSubmitButtonreplaceChildreplaceChildrenreplaceWithrequestFullscreenrequestPointerLockresetrevealActivityrunscrollscrollByscrollIntoViewscrollTosetAttributesetAttributeNSsetAttributeNodesetAttributeNodeNSsetPointerCaptureshowPopoversolutionstoreResponsestoredRunsubmittoggleAttributetogglePopoverupdateActivitywebkitMatchesSelectorwillUpdateaddInitializerextractSpecFromMarkdownfinalizeglobalConfigureglobalFromMarkdownloadDatasetAttributesobservedAttributesattributeChangedCallbackaddControllerremoveControllerdisableWarningenableWarningenabledWarningselementPropertiespropertiescreatePropertygetPropertyDescriptorgetPropertyOptionsrenderOptionsrenderRootshadowRootOptionselementStylesstylesfinalizeStyleshasUpdatedisUpdatePendingupdateCompleteenableUpdatinggetUpdateCompleteperformUpdaterequestUpdatescheduleUpdateshouldUpdateupdateupdated