node is a Comment node.
node is a DocumentFragment node.
node is a document.
Set when other is a descendant of node.
Set when other is an ancestor of node.
Set when node and other are not in the same tree.
Set when other is following node.
Set when other is preceding node.
node is a doctype.
node is an element.
node is a ProcessingInstruction node.
node is a Text node.
Returns node's node document's document base URL.
Returns the children.
Returns the child elements.
Allows 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.
Returns the first child.
Returns the first child that is an element, and null otherwise.
Returns true if node is connected and false otherwise.
Returns the last child.
Returns the last child that is an element, and null otherwise.
Returns the local name.
Returns the namespace.
Returns the first following sibling that is an element, and null otherwise.
Returns the next sibling.
Returns a string appropriate for the type of node.
Returns the type of node.
Fires 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.
Occurs 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.
Returns the parent element.
Returns the parent.
Returns the namespace prefix.
Returns the first preceding sibling that is an element, and null otherwise.
Returns the previous sibling.
Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
Returns 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.
Returns the HTML-uppercased qualified name.
Marks class as having finished creating properties.
Ensure this class is marked as finalized as an optimization ensuring
it will not needlessly try to finalize.
Note this property name is a string to prevent breaking Closure JS Compiler optimizations. See updating-element.ts for more information.
User-supplied object that maps property names to PropertyDeclaration
objects containing options for configuring the property.
Render method used to render the value to the element's DOM.
Array of styles to apply to the element. The styles should be defined
using the css tag function.
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.
The Promise returns a boolean that indicates if the update resolved without triggering another update.
Returns a list of attributes corresponding to the registered properties.
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 { async _getUpdateComplete() { await super._getUpdateComplete(); await this._myChild.updateComplete; } }
Applies styling to the element shadowRoot using the static get styles
property. Styling will apply using shadowRoot.adoptedStyleSheets where
available and will fallback otherwise. When Shadow DOM is polyfilled,
ShadyCSS scopes styles and adds them to the document. When Shadow DOM
is available but adoptedStyleSheets is not, styles are appended to the
end of the shadowRoot to mimic spec
behavior.
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.
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.
Creates a shadow root for element and returns it.
Synchronizes property values when attributes change.
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.
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Returns a bitmask indicating the position of other relative to node.
Returns true if other is an inclusive descendant of node, and false otherwise.
Returns the node into which the element should render and by default
creates and returns an open shadowRoot. Implement to customize where the
element's DOM is rendered. For example, to render into the element's
childNodes, return this.
Returns a node into which to render.
Allows for super.disconnectedCallback() in extensions while
reserving the possibility of making non-breaking feature additions
when disconnecting at some point in the future.
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.
Invoked when the element is first updated. Implement to perform one time work on the element after update.
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Map of changed properties with old values
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Returns the qualified names of all element's attributes. Can contain duplicates.
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.
Returns node's root.
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Returns true if element has attributes, and false otherwise.
Returns whether node has children.
Performs element initialization. By default this calls createRenderRoot
to create the element renderRoot node and captures any pre-set values for
registered properties.
Returns whether node and otherNode have the same properties.
Returns true if matching selectors against element's root yields element, and false otherwise.
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Performs an element update. Note, if an exception is thrown during the
update, firstUpdated and updated will not be called.
You can override this method to change the timing of updates. If this
method is overridden, super.performUpdate() must be called.
For instance, to schedule updates to occur just before the next frame:
protected async performUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.performUpdate();
}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.
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Removes node.
Removes element's first attribute whose qualified name is qualifiedName.
Removes element's attribute whose namespace is namespace and local name is localName.
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.
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.
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 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. Returns the updateComplete Promise which is resolved
when the update completes.
(optional) name of requesting property
(optional) old value of requesting property
A Promise that is resolved when the update completes.
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
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.
Map of changed properties with old values
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.
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.
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.
Map of changed properties with old values
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); }
Creates property accessors for registered properties and ensures any superclasses are also finalized.
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 } } }
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.
Return the array of styles to apply to the element. Override this method to integrate into a style management system.
node is a CDATASection node.