Readonly
ATTRIBUTE_Readonly
CDATA_node is a CDATASection node.
Readonly
COMMENT_node is a Comment node.
Readonly
DOCUMENT_node is a DocumentFragment node.
Readonly
DOCUMENT_node is a document.
Readonly
DOCUMENT_Set when other is a descendant of node.
Readonly
DOCUMENT_Set when other is an ancestor of node.
Readonly
DOCUMENT_Set when node and other are not in the same tree.
Readonly
DOCUMENT_Set when other is following node.
Readonly
DOCUMENT_Readonly
DOCUMENT_Set when other is preceding node.
Readonly
DOCUMENT_node is a doctype.
Readonly
ELEMENT_node is an element.
Readonly
ENTITY_Readonly
ENTITY_Readonly
NOTATION_Readonly
PROCESSING_node is a ProcessingInstruction node.
Readonly
TEXT_node is a Text node.
Readonly
accessReadonly
assignedReadonly
attributeReadonly
attributesReadonly
baseURIReturns node's node document's document base URL.
Readonly
childReadonly
childReturns the children.
Readonly
childrenReturns the child elements.
Readonly
classAllows 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.
Readonly
clientReadonly
clientReadonly
clientReadonly
clientReadonly
datasetReadonly
firstReturns the first child.
Readonly
firstReturns 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.
Readonly
isReturns true if node is connected and false otherwise.
Readonly
isReadonly
lastReturns the last child.
Readonly
lastReturns the last child that is an element, and null otherwise.
Readonly
localReturns the local name.
Readonly
namespaceURIReturns the namespace.
Readonly
nextReturns the first following sibling that is an element, and null otherwise.
Readonly
nextReturns the next sibling.
Readonly
nodeReturns a string appropriate for the type of node.
Readonly
nodeReturns the type of node.
Optional
nonceReadonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetReadonly
offsetFires 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.
Optional
ontouchcancelOptional
ontouchendOptional
ontouchmoveOptional
ontouchstartOccurs 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.
Readonly
ownerReturns the node document. Returns null for documents.
Readonly
parentReturns the parent element.
Readonly
parentReturns the parent.
Readonly
partReadonly
prefixReturns the namespace prefix.
Readonly
previousReturns the first preceding sibling that is an element, and null otherwise.
Readonly
previousReturns the previous sibling.
Readonly
scrollReadonly
scrollReadonly
shadowReturns 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.
Readonly
styleReadonly
tagReturns the HTML-uppercased qualified name.
Reflects the value of the click-trigger
attribute. If not set, or set to an invalid value, this defaults to
"secondary"
.
A value of "primary"
means this menu will be opened on "click"
events. A value of "secondary"
, means this
menu will be opened on "contextmenu"
events. A value of "both" listens to both.
Reflects the value of the linked-elements
attribute, which is a query selector defining all the elements to
listen for "click"
or "contextmenu"
events.
This selector is ran from the root element's scope. In most cases, that will effectively be the same as
document
.
The selector can contain the string #this
, which works exactly as it sounds, enabling simple selectors like
#this + *
meaning the direct sibling after this element, or *:has(+ #this)
meaning the direct sibling before
this element. Though this will only function if the document does not already contain an element with an ID of
this
.
For more information as to how the selector is used and when it is queried, see the
refreshLinkedElements()
method.
Callback function to call when a menu item has been selected. Explicitly returning false
will pervent the menu
from opening, and the default "click" or "contextmenu" behaviour will not be prevented.
If allowEvilAttributes
has been set to true
, this can also
be set to a string
which will be evaluated, therefore enabling the use of the ondropdownopen
attribute as an
inline event handler. The inline event handler will be passed a details
parameter.
Callback function to call when a menu item has been selected. Explicitly returning false
will pervent the menu
from closing.
If allowEvilAttributes
has been set to true
, this can also
be set to a string
which will be evaluated, therefore enabling the use of the ondropdownselect
attribute as
an inline event handler. The inline event handler will be passed a details
parameter.
Reflects the value of the open-position
attribute. If not set, or set to an invalid value, this defaults to
"element-bottom-rightward"
if click-trigger
is "primary" || "both"
, or "pointer"
if click-trigger
is "secondary"
.
See the DropdownOpenPosition documentation for details
Static
observedOptional
options: boolean | AddEventListenerOptionsIf the current active menu exists and was created from this element, then the active menu will be closed
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
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.
Internal
Used to handle "click" and "contextmenu" events of the linked elements. Currently an alias of open, though this may change in a manner which doesn't adhere to semver.
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Removes this element as an event listener from all previously linked elements, if any, then Listens to the
"click"
or "contextmenu"
events, depending on what the
click-trigger
attribute is set to, on all the elements specified by
the linked-elements
attribute.
When the relevant event is emitted on the relevant elements, the menu is opened.
This method is automatically called under the following circumstances
linked-elements
attribute changesclick-trigger
attribute changesOptional
options: 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.
Optional
options: 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.
Optional
force: booleanStatic
allowWhether or not "ondropdownselect"
and "ondropdownopen"
will evaluate string values as functions.
The default value is false
, Unless the root element (the top-most <html>
or <svg>
) has the
data-allow-evil-attributes
attribute set to anything other than an empty string when this library was loaded.
This is because it assumed that HTML sanitizers don't consider the creation of new inline event handlers.
set to true
to be more vulnerable to XSS.
Static
normalizeStatic
normalize
A root-level dropdown menu list. Represented as
<dropdown-menu>
in the document.If you wish to create this element programatically, use
new DropdownMenuElement()
.This element emits custom DOM events on both itself and the linked element which triggered it. This happens when a menu is opened and when the user selects an option. For more information, see the linked documentation listed below.
"dropdownOpen"
"dropdownClose"
"dropdownSelect"
This element has additional HTML attributes which can be used to define its behaviour. For more information, see the linked documentation listed below.
click-trigger
: See theclickTrigger
propertylinked-elements
: See thelinkedElements
propertyondropdownselect
: See theondropdownselect
propertyondropdownopen
: See theondropdownopen
propertyopen-position
: See theopenPosition
propertyThe direct children of this element should only be
<dropdown-menu-item>
or<hr>
elements.If your menus contain inputs, such as check boxes or radio buttons, any programatic changes to their
value
andchecked
properties will not be reflected while the menu is open."input"
and"change"
events will still be fired as normal when the user changes the input values.If you want your menu to have sub-menus, see the
<dropdown-menu-inner>
elementNote that this element is always hidden, and a different element gets shown to the users when they invoke the menu. Therefore, this element should not get targetted for styling. See the
<active-dropdown-menu>
element for details.