HTMLElement
Unofficial
Augments the built-in HTMLElement interface.
Signature:
export interface HTMLElement extends ElementExtends: Element
Properties
| Property | Type | Description | |
|---|---|---|---|
| _EVENTS? | { K in keyof [HTMLElementEventMap]?: EventListenerInfo[]; } | The event listeners of the element. | |
| constructorWin | Window | Global window object. (Inherited from Element) | |
| doc | Document | The document this node belongs to, or the global document. (Inherited from Element) | |
| innerHeight | number | Get the inner height of this element without padding. | |
| innerWidth | number | Get the inner width of this element without padding. | |
| win | Window | The window object this node belongs to, or the global window. (Inherited from Element) |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| addClass(classes?) | void | Adds a class to the element. (Inherited from Element) | |
| addClasses(classes) | void | Adds multiple classes to the element. (Inherited from Element) | |
| appendText(val) | void | Appends a text node to the node. (Inherited from Element) | |
| createDiv(o?, callback?) | HTMLDivElement | Creates a new <div> element.(Inherited from Element) | |
| createEl(tag, o?, callback?) | HTMLElementTagNameMap[K] | Create an element and append it to this node. (Inherited from Element) | |
| createSpan(o?, callback?) | HTMLSpanElement | Creates a new <span> element.(Inherited from Element) | |
| createSvg(tag, o?, callback?) | SVGElementTagNameMap[K] | Creates a new svg element such as <svg>, <circle>, <rect>, etc.(Inherited from Element) | |
| detach() | void | Detaches the node from the DOM. (Inherited from Element) | |
| empty() | void | Empties the node. (Inherited from Element) | |
| find(selector) | Element | null | Finds the first descendant element that matches the selector. (Inherited from Element) | |
| findAll(selector) | Element[] | Finds all descendant elements that match the selector. (Inherited from Element) | |
| findAllSelf(selector) | Element[] | Finds all descendant elements or self that match the selector. (Inherited from Element) | |
| getAttr(qualifiedName) | null | string | Gets an attribute from the element. (Inherited from Element) | |
| getCssPropertyValue(property, pseudoElement?) | string | Gets the value of a CSS property of the element. (Inherited from Element) | |
| getText() | string | Returns the text content of the element. (Inherited from Element) | |
| hasClass(cls) | boolean | Checks if the element has a class. (Inherited from Element) | |
| hide() | void | Hides the element using css display property. | |
| indexOf(other) | number | Returns the index of the node or -1 if the node is not found.(Inherited from Element) | |
| insertAfter(node, child) | T | Inserts a child node after the current node. (Inherited from Element) | |
| instanceOf(type) | this is T | Cross-window capable instanceof check, a drop-in replacement for instanceof checks on DOM Nodes. Remember to also check for nulls when necessary. (Inherited from Element) | |
| isActiveElement() | boolean | Checks if the element is the active element. (Inherited from Element) | |
| isShown() | boolean | Returns whether this element is shown, when the element is attached to the DOM and none of the parent and ancestor elements are hidden with display: none.Exception: Does not work on <body> and <html>, or on elements with position: fixed. | |
| matchParent(selector, lastParent?) | Element | null | Matches the selector recursively up the DOM tree. (Inherited from Element) | |
| off(this, type, selector, listener, options?) | void | Removes an event listener from the element. | |
| on(this, type, selector, listener, options?) | void | Adds an event listener to the element. | |
| onClickEvent(this, listener, options?) | void | Adds a click event listener to the element. | |
| onNodeInserted(this, listener, once?) | () => void | Adds an event listener to the element when it is inserted into the DOM. | |
| onWindowMigrated(this, listener) | () => void | Adds an event listener to the element when it is migrated to another window. | |
| removeClass(classes?) | void | Removes a class from the element. (Inherited from Element) | |
| removeClasses(classes) | void | Removes multiple classes from the element. (Inherited from Element) | |
| setAttr(qualifiedName, value) | void | Sets an attribute on the element. (Inherited from Element) | |
| setAttrs(obj) | void | Sets multiple attributes on the element. (Inherited from Element) | |
| setChildrenInPlace(children) | void | Sets the children of the node. (Inherited from Element) | |
| setCssProps(props) | void | Sets the CSS properties of the element. | |
| setCssStyles(styles) | void | Sets the CSS styles of the element. | |
| setText(val) | void | Sets the text content of the element. (Inherited from Element) | |
| show() | void | Shows the element using css display property. | |
| toggle(show) | void | Toggles the visibility of the element using css display property. | |
| toggleClass(classes, value) | void | Toggles a class on the element. (Inherited from Element) | |
| toggleVisibility(visible) | void | Toggles the visibility of the element using css visibility property. | |
| trigger(eventType) | void | Triggers an event on the element. |
Links to this page:
- AbstractFileTreeItem
- AbstractInputSuggest
- AbstractSearchComponent
- AliasesPropertyWidgetComponent
- AllPropertiesView
- AppSetting
- BasesView
- blinkFormData
- BookmarksPluginInstance
- BookmarksView
- Cm5BookmarkOptions
- Cm5Editor
- Cm5EditorConfiguration
- Cm5EditorDisplay
- Cm5TextMarkerOptions
- CodeMirrorEditor
- CommandPaletteModal
- ConfirmationModal
- DeferredView
- displayTooltip
- DisplayValueComponent
- DOMPurifyI
- DragManager
- DropResult
- Editor
- EditorSearchComponent
- EditorSuggest
- ElectronWebviewTag
- EmbedContext
- EmbeddedEditorView
- EmptyView
- ExtraButtonComponent
- FileExplorerView
- FileSuggest
- FileTreeItem
- FileView
- fish
- fishAll
- FolderTreeItem
- FuzzySuggestModal
- getButtonComponentConstructor
- getColorComponentConstructor
- getConfirmationButtonConstructor
- getDisplayValueComponentConstructor
- getDropdownComponentConstructor
- getExtraButtonComponentConstructor
- getHoverPopoverConstructor
- getMarkdownPreviewRendererConstructor
- getMarkdownRenderChildConstructor
- getMarkdownRendererConstructor
- getMomentFormatComponentConstructor
- getObsidianDOMConstructor
- getProgressBarComponentConstructor
- getQueryControllerConstructor
- getSearchComponentConstructor
- getSecretComponentConstructor
- getSettingConstructor
- getSettingGroupConstructor
- getSliderComponentConstructor
- getStatusBarConstructor
- getTextAreaComponentConstructor
- getTextComponentConstructor
- getToggleComponentConstructor
- getWorkspaceConstructor
- GraphOptions
- GraphView
- HotkeysSettingTab
- HoverLinkEvent
- HoverPopover
- htmlToMarkdown
- IApplicationOptions
- IFramedMarkdownEditor
- InfinityScroll
- InfoFileView
- ItemView
- MarkdownBaseView
- MarkdownPreviewRenderer
- MarkdownPreviewView
- MarkdownRenderChild
- MarkdownRenderer
- MarkdownScrollableEditView
- MarkdownView
- MathJaxEx
- Menu
- MenuItem
- MenuSeparator
- MetadataEditor
- MetadataEditorProperty
- Modal
- MomentFormatComponent
- Notice
- ObsidianDOM
- ObsidianTouchEvent
- Plugin
- PluginSettingTab
- PopoverSuggest
- PropertyPropertyWidgetComponentComboBox
- ReadViewRenderer
- ReleaseNotesView
- RendererSection
- renderMatches
- renderMath
- renderResults
- ResultDomItem
- ResultDomItemChild
- RibbonItem
- RunOptions
- Scope
- SearchComponent
- SearchView
- setIcon
- Setting
- SettingDefinitionAction
- SettingDefinitionAddItem
- SettingGroup
- SettingPage
- SettingTab
- setTooltip
- StatusBar
- SuggestionContainer
- SuggestModal
- SyncView
- TableCell
- TableCellEditor
- TableView
- TagView
- TextPropertyWidgetComponent
- ToggleComponent
- Tree
- TreeCollapsibleItem
- TreeItem
- TreeNode
- TreeRoot
- TypedWorkspaceLeaf
- UnknownView
- View
- WebviewerHistoryView
- WebviewerView
- WidgetEditorView
- Window
- WindowSelection
- Workspace
- WorkspaceLeaf
- WorkspaceRibbon
- WorkspaceTabs