Readonly
actionReadonly
attributesReadonly
classesReadonly
dataOptional
descriptionProtected
enteredProtected
Optional
hasOptional
observingOptional
removedReadonly
styleOptional
textOptional
undiscoveredOptional
wrapperStatic
mapThe dataset
of the internal element.
The element that this Component
instance wraps.
The selectable layer of this element, or false
if it is not selectable.
Alias of .element.addEventListener
, except it returns this
instead and prevents memory leaks
Optional
options: boolean | AddEventListenerOptionsOptional
options: boolean | AddEventListenerOptionsAppends every element of a list of components/elements.
Rest
...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>A varargs list of elements or iterables of elements. Falsy values are skipped
Appends every element of a list of components/elements.
Where in this component to insert new components. See AppendStrategy
Rest
...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>A varargs list of elements or iterables of elements. Falsy values are skipped
Appends this component to another element, by selector, element, or component.
Optional
where: null | string | HTMLElement | default<HTMLElement>A CSS selector, an element, or a component to append this component to.
Optional
appendStrategy: AppendStrategyWhere in the new container to insert this component. See AppendStrategy
Removes all children.
Removes all children that are not filtered out with the given filter function.
Returns a stream of this component's child components. Child elements that don't have associated components will be undefined
.
Optional
selector: stringA selector that each element must match to be included in the result stream
Hides the element. If a tooltip is shown for this element, hides that as well.
Protected
onProtected
onProtected
onProtected
onProtected
playAppends every element of a list of components/elements.
Rest
...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>A varargs list of elements or iterables of elements. Falsy values are skipped
Appends this component to another element, by selector, element, or component.
Optional
where: null | string | HTMLElement | default<HTMLElement>A CSS selector, an element, or a component to append this component to.
Rest
...untilEvents: (keyof IButtonEvents)[]Rest
...untilEvents: (keyof IButtonEvents)[]Removes this element and all descendants.
Runs the given callback with the given arguments. this
and the first argument are this element.
Optional
cb: ((this: ActionButton, component: ActionButton, ...args: A) => any)The callback to run.
Rest
...args: ARest
...args: AThe arguments with which to call the callback.
Runs the given callback with the given arguments. this
and the first argument are this element.
Optional
cb: ((this: ActionButton, component: ActionButton) => any)The callback to run.
Rest
...args: any[]The arguments with which to call the callback.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
The amount of time to wait before running the callback, in milliseconds.
The callback to run.
Rest
...args: ARest
...args: AThe arguments with which to call the callback.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
The amount of time to wait before running the callback, in milliseconds.
Optional
cb: ((this: ActionButton, component: ActionButton) => any)The callback to run.
Rest
...args: any[]The arguments with which to call the callback.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
The amount of time to wait before running the callback, in milliseconds.
The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)
The callback to run.
Rest
...args: ARest
...args: AThe arguments with which to call the callback.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
The amount of time to wait before running the callback, in milliseconds.
The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)
Optional
cb: ((this: ActionButton, component: ActionButton) => any)The callback to run.
Rest
...args: any[]The arguments with which to call the callback.
Scrolls this element so the given child is at the top of the viewport.
Optional
child: HTMLElement | default<HTMLElement>The child to scroll to
Optional
ms: numberThe time to take, defaulting to 1000 (1 second)
Scrolls this element so the given child is at the top of the viewport.
The child to scroll to
An offset for the position to scroll to, relative to the position of the child
Optional
ms: numberThe time to take, defaulting to 1000 (1 second)
Sets the contents of this element using innerHTML
.
The content, an HTML string. Script tags will not be executed, as per the normal functionality of innerHTML
Only the text within the HTML will be appended, not the tags.
Removes the context menu from this element.
Sets the context menu for this element.
Optional
priority: numberWarning: This method will replace the internal element backing this component.
Only call this directly after constructing the element.
Warning: This method will replace the internal element backing this component.
Only call this directly after constructing the element.
Optional
elementType: stringOptional
namespace: SVGOptional
highlight: IHighlightOptional
icon: IIconSets the ID of this component's element.
Optional
sound: SfxType | "sort" | "equip" | "unequip" | "activate" | "choose" | "close" | "disable" | "enable" | "input" | "inputdelete" | "invalid" | "open" | "opensmall" | "protect" | "reorder" | "select" | "stack" | "trade" | "unprotect" | "unstack"Optional
text: TranslationGeneratorSets the tooltip options for this element. Setting the tooltip to undefined, or not providing the argument removes the tooltip options.
Shows the element.
Returns a stream of this component's sibling components. Child elements that don't have associated components will be undefined
.
Optional
selector: stringA selector that each element must match to be included in the result stream
Moves this element to a hidden element, in order to retain any information the element had. This allows the element to be re-appended later without re-adding event handlers, CSS, or any other data.
Toggles the visibility of this element. Internally uses show
and hide
.
Optional
visible: booleanThe new visiblity of this element.
Static
allStatic
appendStatic
findStatic
getStatic
getStatic
removeGenerated using TypeDoc
The number of child elements of this component.