Class default

Hierarchy

Constructors

constructor

Properties

attributes buttonBack canCancel classes confirmButtons content data description entered event filter header menuId observing? removed? rowToggleAllMods sections sortRow staticContent style tabContainer? tabs title warningAllModsDisabled

Accessors

childCount dataset element isSubmenu selectable

Methods

addEventListener addSubtabs addTabs append appendTo clearTabs closest contains deregisterBindHandlers deregisterEventBusSubscriber dump exists findDescendants getAs getBox getChildren getClosestDialog getDialog getIndex getMenu getModRow getNthChild getOffset getParent getScreen getSelectionTarget getTabs hide highlightVisibleTabs isFocused isSelectable isVisible matches observe onContextMenu onEnter onHide onLeave onOverlayHidden onShowMenu preShow? queryX queryXAll reflow refreshMods refreshTooltip regenerateBoxes registerBindHandlers registerEventBusSubscriber remove removeEventListener removeTooltip repaint schedule scrollTo scrollToTabSection scrollToTop setContents setContextMenu setDescription setElement setFilter setHighlight setId setInitialSelection setIsSubmenu setSectionsForcedOpen setSelectable setStyle setTitle setTooltip show showMenu siblings sleep store toggle wentBackTo all append findDescendants get getSelectableLayer remove

Constructors

constructor

Properties

Readonly attributes

attributes: AttributeManipulator<default>

Readonly buttonBack

buttonBack: BackButton = ...

canCancel

canCancel: undefined | boolean

Readonly classes

classes: ClassManipulator<default>

confirmButtons

confirmButtons: ConfirmButtonHandler = ...

Readonly content

content: default<HTMLElement>

Readonly data

data: DataManipulator<default>

Readonly description

description: default = ...

Protected entered

entered: boolean = false

event

event: IEventEmitter<default, IMenuEvents>

filter

filter: default = ...

Readonly header

header: BlockRow = ...

menuId

menuId: string | MenuId

Optional observing

observing?: boolean

Optional removed

removed?: string | boolean

Readonly rowToggleAllMods

rowToggleAllMods: EnableDisableAllRow = ...

Readonly sections

sections: {
    0: ModSection;
    1: ModSection;
    2: ModSection;
} = ...

Type declaration

  • 0: ModSection
  • 1: ModSection
  • 2: ModSection

Readonly sortRow

sortRow: default<ModSort> = ...

Readonly staticContent

staticContent: default<HTMLElement> = ...

Readonly style

style: StyleManipulator<default>

Optional tabContainer

tabContainer?: default<HTMLElement>

Readonly tabs

tabs: Map<string | number, Tab<undefined | string | number>> = ...

Readonly title

title: Heading = ...

Readonly warningAllModsDisabled

warningAllModsDisabled: default = ...

Accessors

childCount

  • get childCount(): number

  • The number of child elements of this component.

    Returns number

dataset

  • get dataset(): DOMStringMap

  • The dataset of the internal element.

    Returns DOMStringMap

element

  • get element(): E

  • The element that this Component instance wraps.

    Returns E

isSubmenu

  • get isSubmenu(): boolean

  • Returns boolean

selectable

  • get selectable(): false | SelectableLayer

  • The selectable layer of this element, or false if it is not selectable.

    Returns false | SelectableLayer

Methods

addEventListener

  • Alias of .element.addEventListener, except it returns this instead and prevents memory leaks

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns default

addSubtabs

  • Parameters

    • tab: Tab<undefined | string | number>

    Returns default

addTabs

  • Parameters

    • Rest ...tabs: ArrayOfIterablesOr<Tab<undefined | string | number>>

    Returns void

append

  • Appends every element of a list of components/elements.

    Parameters

    • Rest ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>

      A varargs list of elements or iterables of elements. Falsy values are skipped

    Returns default

  • Appends every element of a list of components/elements.

    Parameters

    • appendStrategy: AppendStrategy

      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

    Returns default

appendTo

  • Appends this component to another element, by selector, element, or component.

    Parameters

    • Optional where: null | string | HTMLElement | default<HTMLElement>

      A CSS selector, an element, or a component to append this component to.

    • Optional appendStrategy: AppendStrategy

      Where in the new container to insert this component. See AppendStrategy

    Returns default

clearTabs

  • Returns void

closest

  • An alias for element.closest(selector)

    Parameters

    • selector: string

    Returns null | Element

contains

  • Returns whether this component contains the given element.

    Parameters

    • Optional what: null | string | Node | default<HTMLElement>

    Returns boolean

deregisterBindHandlers

deregisterEventBusSubscriber

dump

  • Removes all children.

    Returns default

  • Removes all children that are not filtered out with the given filter function.

    Parameters

    • Optional filter: ((element: HTMLElement, component?: default<HTMLElement>) => boolean)

      A function that returns true if the child should be kept.

        • (element: HTMLElement, component?: default<HTMLElement>): boolean

        • Parameters

          • element: HTMLElement
          • Optional component: default<HTMLElement>

          Returns boolean

    Returns default

exists

  • Returns boolean

findDescendants

  • An alias for element.querySelectorAll(selector)

    Type Parameters

    • E extends HTMLElement = HTMLElement

    Parameters

    • selector: string

    Returns NodeListOf<E>

getAs

  • Type Parameters

    Parameters

    • cls: Class<C, any[]>

    Returns undefined | C

getBox

  • A cached alias for element.getBoundingClientRect(). Boxes are updated or regenerated as ancestors shift.

    Parameters

    • regenIfZero: boolean = true
    • forceRegen: boolean = false

    Returns default

getChildren

  • Returns a stream of this component's child components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

Protected getClosestDialog

getDialog

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns null | D

getIndex

  • Returns the index of this component amongst its sibling nodes. If it has no parent, it returns undefined.

    Parameters

    • elementsOnly: boolean = false

    Returns undefined | number

getMenu

  • Returns this component's containing menu, if it exists.

    Type Parameters

    Returns null | M

getModRow

  • Parameters

    • index: number

    Returns undefined | default

getNthChild

  • Returns the nth child, defaulting to the first child

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Parameters

    • nth: number = 0

    Returns undefined | C

getOffset

  • Returns an object containing HTMLElement.offsetTop and HTMLElement.offsetLeft

    Returns {
        left: number;
        top: number;
    }

    • left: number
    • top: number

getParent

  • Returns this component's parent component, if it exists.

    Type Parameters

    • C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>

    Returns null | C

getScreen

  • Returns this component's containing dialog, if it exists.

    Type Parameters

    Returns null | S

getSelectionTarget

getTabs

  • Returns Stream<Tab<undefined | string | number>>

hide

  • Hides the element. If a tooltip is shown for this element, hides that as well.

    Returns default

Protected highlightVisibleTabs

  • Returns void

isFocused

  • Returns boolean

isSelectable

  • Returns boolean

isVisible

  • Returns whether the element is visible.

    Returns boolean

matches

  • Parameters

    • selector: string

    Returns boolean

observe

  • Enables a intersection observe on this component and fires an observe event once when the element is first observed

    Returns void

Protected onContextMenu

Protected onEnter

  • Parameters

    • reason: "focus" | "mouse"

    Returns void

Protected onHide

  • Returns Promise<void>

Protected onLeave

  • Parameters

    • reason: "remove" | "focus" | "mouse"

    Returns void

Protected onOverlayHidden

  • Returns Promise<void>

Protected onShowMenu

  • Returns void

Protected Optional preShow

  • Returns Promise<void>

queryX

  • Type Parameters

    • N extends Node = Node

    Parameters

    • selector: string

    Returns null | N

queryXAll

  • Type Parameters

    • N extends Node = Node

    Parameters

    • selector: string

    Returns N[]

reflow

  • Parameters

    • reason: string

    Returns void

Protected refreshMods

  • Returns void

refreshTooltip

  • Returns void

regenerateBoxes

  • Forcibly regenerates the cached result of Component.getBox for this component and all descendants.

    Parameters

    • descendants: boolean = true

    Returns void

registerBindHandlers

  • Parameters

    Returns void

  • Parameters

    • warnIfNoHandlers: false
    • Rest ...untilEvents: (keyof IMenuEvents)[]

    Returns void

registerEventBusSubscriber

remove

  • Removes this element and all descendants.

    Returns default

removeEventListener

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this: HTMLElement, ev: HTMLElementEventMap[K]): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    Returns default

removeTooltip

  • Returns void

repaint

  • Triggers a repaint on this element.

    Returns void

schedule

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • Optional cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments. this and the first argument are this element.

    Parameters

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Type Parameters

    • A extends any[]

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • cb: ((this: default, component: default, ...args: A) => any)

      The callback to run.

    • Rest ...args: A

      The arguments with which to call the callback.

    Returns default

  • Runs the given callback with the given arguments, after the specified amount of time. this and the first argument are this element.

    Parameters

    • ms: number

      The amount of time to wait before running the callback, in milliseconds.

    • debounce: number

      The span of time to debounce in. (If this callback was scheduled again in this time, skip this earlier call)

    • Optional cb: ((this: default, component: default) => any)

      The callback to run.

    • Rest ...args: any[]

      The arguments with which to call the callback.

    Returns default

scrollTo

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • Optional child: HTMLElement | default<HTMLElement>

      The child to scroll to

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

  • Scrolls this element so the given child is at the top of the viewport.

    Parameters

    • child: undefined | HTMLElement | default<HTMLElement>

      The child to scroll to

    • offsetTop: number

      An offset for the position to scroll to, relative to the position of the child

    • Optional ms: number

      The time to take, defaulting to 1000 (1 second)

    Returns void

scrollToTabSection

  • Parameters

    • tabId: string | number

    Returns default

scrollToTop

  • Returns void

setContents

  • Sets the contents of this element using innerHTML.

    Parameters

    • html: string

      The content, an HTML string. Script tags will not be executed, as per the normal functionality of innerHTML

    • escape: boolean = false

      Only the text within the HTML will be appended, not the tags.

    Returns default

setContextMenu

  • Removes the context menu from this element.

    Returns default

  • Sets the context menu for this element.

    Parameters

    • generator: ((contextMenu: ContextMenu, api: IBindHandlerApi) => undefined | ContextMenu)
        • (contextMenu: ContextMenu, api: IBindHandlerApi): undefined | ContextMenu

        • Parameters

          Returns undefined | ContextMenu

    • Optional priority: number

    Returns default

setDescription

setElement

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • element: HTMLElement

    Returns default

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • Optional elementType: string
    • Optional namespace: SVG

    Returns default

setFilter

  • Parameters

    • filter: string = ""

    Returns default

setHighlight

setId

  • Sets the ID of this component's element.

    Parameters

    • id: string

    Returns default

setInitialSelection

  • Parameters

    • initialSelection: boolean = true

    Returns default

setIsSubmenu

  • Parameters

    • submenu: boolean = true

    Returns default

setSectionsForcedOpen

  • Parameters

    • forcedOpen: boolean = true

    Returns default

setSelectable

setStyle

  • Parameters

    • property: string
    • value: string | number

    Returns default

setTitle

setTooltip

  • Sets the tooltip options for this element. Setting the tooltip to undefined, or not providing the argument removes the tooltip options.

    Type Parameters

    • ARGS extends any[]

    Parameters

    • Optional initializer: ((tooltip: default, ...args: ARGS) => any)
        • (tooltip: default, ...args: ARGS): any

        • Parameters

          • tooltip: default
          • Rest ...args: ARGS

          Returns any

    • Rest ...args: ARGS

    Returns default

show

  • Deprecated

    Use Menu.showMenu()

    Returns default

showMenu

  • Returns void | Promise<void>

siblings

  • Returns a stream of this component's sibling components. Child elements that don't have associated components will be undefined.

    Type Parameters

    Parameters

    • Optional selector: string

      A selector that each element must match to be included in the result stream

    Returns Stream<C>

sleep

  • Returns

    a promise that resolves when either the given time has passed, or this component has been removed. Returns true if this component exists, false if it has been removed.

    Parameters

    • ms: number

    Returns Promise<boolean>

store

  • 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.

    Parameters

    Returns default

toggle

  • Toggles the visibility of this element. Internally uses show and hide.

    Parameters

    • visible: boolean = ...

      The new visiblity of this element.

    Returns default

wentBackTo

  • When called in show or after ComponentEvent.Show, returns whether the menu was "went back to" from a descendant menu.

    Returns boolean

Static all

  • Parameters

    • selector: string

    Returns Stream<default<HTMLElement>>

Static append

  • Parameters

    • elementToMove: string | HTMLElement | default<HTMLElement>
    • placeToAppendTo: string | HTMLElement | default<HTMLElement>
    • strategy: AppendStrategy = "append"

    Returns void

Static findDescendants

  • Parameters

    • inElement: HTMLElement | default<HTMLElement>
    • selector: string
    • includeSelf: boolean = false

    Returns HTMLElement[]

Static get

  • Parameters

    • selector: string

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>

    Returns default<HTMLElement>

  • Parameters

    • event: Event

    Returns default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>

    Returns undefined | default<HTMLElement>

  • Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Parameters

    • element: undefined | null | false | Element | default<HTMLElement>
    • create: undefined | false

    Returns undefined | default<HTMLElement>

  • Type Parameters

    Parameters

    • selector: string

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C

    Returns C

  • Type Parameters

    Parameters

    • event: Event

    Returns C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C

    Returns undefined | C

  • Type Parameters

    Parameters

    • selector: string
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: Element | C
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • event: Event
    • create: undefined | false

    Returns undefined | C

  • Type Parameters

    Parameters

    • element: undefined | null | false | Element | C
    • create: undefined | false

    Returns undefined | C

Static getSelectableLayer

  • Parameters

    • element: HTMLElement | default<HTMLElement>

    Returns number | false

Static remove

  • Parameters

    • elementToRemove: null | string | Element | ChildNode | default<HTMLElement>
    • force: boolean = false

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc