ReadonlyATTRIBUTE_ReadonlyCDATA_node is a CDATASection node.
ReadonlyCOMMENT_node is a Comment node.
ReadonlyDOCUMENT_node is a DocumentFragment node.
ReadonlyDOCUMENT_node is a document.
ReadonlyDOCUMENT_Set when other is a descendant of node.
ReadonlyDOCUMENT_Set when other is an ancestor of node.
ReadonlyDOCUMENT_Set when node and other are not in the same tree.
ReadonlyDOCUMENT_Set when other is following node.
ReadonlyDOCUMENT_ReadonlyDOCUMENT_Set when other is preceding node.
ReadonlyDOCUMENT_node is a doctype.
ReadonlyELEMENT_node is an element.
ReadonlyENTITY_ReadonlyENTITY_ReadonlyNOTATION_ReadonlyPROCESSING_node is a ProcessingInstruction node.
ReadonlyTEXT_node is a Text node.
ReadonlyaccessReadonlyassignedReadonlyattributeReadonlyattributesReadonlybaseURIReturns node's node document's document base URL.
ReadonlychildReadonlychildReturns the children.
ReadonlychildrenReturns the child elements.
ReadonlyclassAllows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns the value of element's class content attribute. Can be set to change it.
ReadonlyclientReadonlyclientReadonlyclientReadonlyclientReadonlydatasetThe direction of the element.
ReadonlyfirstReturns the first child.
ReadonlyfirstReturns the first child that is an element, and null otherwise.
Returns the value of element's id content attribute. Can be set to change it.
ReadonlyisReturns true if node is connected and false otherwise.
ReadonlyisOptionallabelThe language of the element.
ReadonlylastReturns the last child.
ReadonlylastReturns the last child that is an element, and null otherwise.
ReadonlylocalReturns the local name.
Use the UmbLocalizeController to localize your element.
ReadonlynamespaceURIReturns the namespace.
ReadonlynextReturns the first following sibling that is an element, and null otherwise.
ReadonlynextReturns the next sibling.
ReadonlynodeReturns a string appropriate for the type of node.
ReadonlynodeReturns the type of node.
OptionalnonceReadonlyoffsetReadonlyoffsetReadonlyoffsetReadonlyoffsetReadonlyoffsetFires when the user aborts the download.
Fires when the object loses the input focus.
Occurs when playback is possible, but would require further buffering.
Fires when the contents of the object or selection have changed.
Fires when the user clicks the left mouse button on the object
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Fires when the user double-clicks the object.
Fires on the source object continuously during a drag operation.
Fires on the source object when the user releases the mouse at the close of a drag operation.
Fires on the target element when the user drags the object to a valid drop target.
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Fires on the target element continuously while the user drags the object over a valid drop target.
Fires on the source object when the user starts to drag a text selection or selected object.
Occurs when the duration attribute is updated.
Occurs when the media element is reset to its initial state.
Occurs when the end of playback is reached.
Fires when an error occurs during object loading.
Fires when the object receives focus.
Fires when the user presses a key.
Fires when the user presses an alphanumeric key.
Fires when the user releases a key.
Fires immediately after the browser loads the object.
Occurs when media data is loaded at the current playback position.
Occurs when the duration and dimensions of the media have been determined.
Occurs when Internet Explorer begins looking for media data.
Fires when the user clicks the object with either mouse button.
Fires when the user moves the mouse over the object.
Fires when the user moves the mouse pointer outside the boundaries of the object.
Fires when the user moves the mouse pointer into the object.
Fires when the user releases a mouse button while the mouse is over the object.
Occurs when playback is paused.
Occurs when the play method is requested.
Occurs when the audio or video has started playing.
Occurs to indicate progress while downloading media data.
Occurs when the playback rate is increased or decreased.
Fires when the user resets a form.
Fires when the user repositions the scroll box in the scroll bar on the object.
Occurs when the seek operation ends.
Occurs when the current playback position is moved.
Fires when the current selection changes.
Occurs when the download has stopped.
Occurs if the load operation has been intentionally halted.
Occurs to indicate the current playback position.
OptionalontouchcancelOptionalontouchendOptionalontouchmoveOptionalontouchstartOccurs when the volume is changed, or playback is muted or unmuted.
Occurs when playback stops because the next frame of a video resource is not available.
ReadonlyownerReturns the node document. Returns null for documents.
ReadonlyparentReturns the parent element.
ReadonlyparentReturns the parent.
ReadonlypartReadonlyprefixReturns the namespace prefix.
ReadonlypreviousReturns the first preceding sibling that is an element, and null otherwise.
ReadonlypreviousReturns the previous sibling.
ReadonlyscrollReadonlyscrollReadonlyshadowReturns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Returns the value of element's slot content attribute. Can be set to change it.
ReadonlystyleReadonlytagReturns the HTML-uppercased qualified name.
Optionaloptions: boolean | AddEventListenerOptionsReturns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
A Promise with the reference to the Context Api Instance
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.
An Observable to observe from.
Callback method called when data is changed.
OptionalcontrollerAlias: null | UmbControllerAliasReference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Optionaloptions: boolean | EventListenerOptionsDisplays 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.
Optionaloptions: FullscreenOptionsIf 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.
Optionalforce: booleanSynchronizes 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.
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.
ReadonlyrenderReadonlyrenderNode or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
ProtectedcreateProtectedrenderIs set to true after the first update. The element code cannot assume
that renderRoot exists before the element hasUpdated.
True if there is a pending update as a result of calling requestUpdate().
Should only be read.
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.
A promise of a boolean that resolves to true if the update completed without triggering another update.
ProtectedenableProtectedfirstInvoked when the element is first updated. Implement to perform one time work on the element after update.
firstUpdated() {
this.renderRoot.getElementById('my-text-area').focus();
}
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Map of changed properties with old values
ProtectedgetOverride 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;
}
}
A promise of a boolean that resolves to true if the update completed without triggering another update.
ProtectedperformPerforms 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.
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.
Optionalname: PropertyKeyname of requesting property
OptionaloldValue: unknownold value of requesting property
Optionaloptions: PropertyDeclaration<unknown, unknown>property options to use instead of the previously configured options
ProtectedscheduleSchedules 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();
}
ProtectedshouldControls 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.
Map of changed properties with old values
ProtectedupdateUpdates 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.
Map of changed properties with old values
ProtectedupdatedInvoked 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.
Map of changed properties with old values
ProtectedwillInvoked before update() to compute values needed during the update.
Implement willUpdate to compute property values that depend on other
properties and are used in the rest of the update process.
willUpdate(changedProperties) {
// only need to check changed properties for an expensive computation.
if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
}
}
render() {
return html`SHA: ${this.sha}`;
}
The base class for all Umbraco LitElement elements.
Abstract
Remarks
This class is a wrapper around the LitElement class.