Abstract
Protected
activeProtected
activeReadonly
attributesProtected
Readonly
bodyReadonly
classesReadonly
dataProtected
enteredProtected
Readonly
headerReadonly
idProtected
Readonly
internalReadonly
logOptional
observingProtected
Readonly
panelOptional
removedProtected
Readonly
scrollableProtected
storeReadonly
styleReadonly
subProtected
subpanelProtected
Readonly
subpanelProtected
subpanelsThe number of child elements of this component.
The dataset
of the internal element.
The element that this Component
instance wraps.
Protected
footerThe 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 | 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
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
Protected
getProtected
getThe name is displayed in the Move To
context menu option, and in the Switch With
options
Protected
Abstract
getImplements the abstract method in "TabDialog". Returns an array of tuples containing information used to set-up the subpanels of this dialog.
If the subpanel classes haven't been instantiated yet, it first instantiates them by calling getSubpanels.
This includes binding a WillRemove
event handler to the panel, which will store
(cache) the panel instead of removing it,
and trigger a SwitchAway
event on the panel when this occurs.
Protected
Abstract
getProtected
initializeProtected
onProtected
onProtected
onProtected
onProtected
onProtected
onProtected
onProtected
onReturns a function that will be executed when the passed subpanel is shown.
When executed, the return function will append the panel to show to the passed component (which is the panel wrapper
of the TabDialog
), and trigger a SwitchTo
event on the panel.
Rest
...untilEvents: (keyof ITabDialogEvents)[]Rest
...untilEvents: (keyof ITabDialogEvents)[]Runs the given callback with the given arguments. this
and the first argument are this element.
Runs the given callback with the given arguments. this
and the first argument are this element.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
Runs the given callback with the given arguments, after the specified amount of time.
this
and the first argument are this element.
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: 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: default<T>, component: default<T>) => 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: IHighlightSets the dialog position.
Sets the tooltip options for this element. Setting the tooltip to undefined, or not providing the argument removes the tooltip options.
Protected
showReturns 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.
Protected
updateStatic
allStatic
appendStatic
findStatic
getStatic
getStatic
makeStatic
removeGenerated using TypeDoc
The positions of each edge of the dialog. Stored as percentages.