Class default<E>

Type Parameters

E extends HTMLElement = HTMLElement

Hierarchy

Index

Constructors

constructor

new default<E>(elementType?: string, namespace?: SVG): default<E>
Type Parameters
- E extends HTMLElement = HTMLElement
Parameters
- Optional elementType: string
- Optional namespace: SVG
Returns default<E>
Overrides Host.constructor
- Defined in src/game/ui/component/Component.ts:466

Properties

`Readonly` attributes

attributes: AttributeManipulator<default<E>>

`Readonly` classes

classes: ClassManipulator<default<E>>

`Readonly` data

data: DataManipulator<default<E>>

`Protected` entered

entered: boolean = false

`Readonly` event

event: IEventEmitter<default<E>, IComponentEvents> = ...

`Optional` observing

observing?: boolean

`Optional` removed

removed?: string | boolean

`Readonly` style

style: StyleManipulator<default<E>>

Accessors

childCount

get childCount(): number
The number of child elements of this component.

Returns number
- Defined in src/game/ui/component/Component.ts:440

dataset

get dataset(): DOMStringMap
The dataset of the internal element.

Returns DOMStringMap
- Defined in src/game/ui/component/Component.ts:434

element

get element(): E
The element that this Component instance wraps.

Returns E
- Defined in src/game/ui/component/Component.ts:421

selectable

get selectable(): false | SelectableLayer
The selectable layer of this element, or false if it is not selectable.

Returns false | SelectableLayer
- Defined in src/game/ui/component/Component.ts:462

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any), options?: boolean | AddEventListenerOptions): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:484

append

append(...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:996
append(appendStrategy: AppendStrategy, ...elements: ArrayOfIterablesOr<undefined | false | HTMLElement | default<HTMLElement>>): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:1002

appendTo

appendTo(where?: null | string | HTMLElement | default<HTMLElement>, appendStrategy?: AppendStrategy): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:984

closest

closest(selector: string): null | Element
An alias for element.closest(selector)
Parameters
- selector: string
Returns null | Element
- Defined in src/game/ui/component/Component.ts:975

contains

contains(what?: null | string | Node | default<HTMLElement>): boolean
Returns whether this component contains the given element.
Parameters
- Optional what: null | string | Node | default<HTMLElement>
Returns boolean
- Defined in src/game/ui/component/Component.ts:946

deregisterBindHandlers

deregisterBindHandlers(): void
Returns void
- Defined in src/game/ui/component/Component.ts:818

deregisterEventBusSubscriber

deregisterEventBusSubscriber(): void
Returns void
- Defined in src/game/ui/component/Component.ts:790

dump

dump(): default<E>
Removes all children.

Returns default<E>
- Defined in src/game/ui/component/Component.ts:1034
dump(filter?: ((element: HTMLElement, component?: default<HTMLElement>) => boolean)): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:1039

exists

exists(): boolean
Returns boolean
- Defined in src/game/ui/component/Component.ts:519

findDescendants

findDescendants<E>(selector: string): NodeListOf<E>
An alias for element.querySelectorAll(selector)
Type Parameters
- E extends HTMLElement = HTMLElement
Parameters
- selector: string
Returns NodeListOf<E>
- Defined in src/game/ui/component/Component.ts:960

getAs

getAs<C>(cls: Class<C, any[]>): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- cls: Class<C, any[]>
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:511

getBox

getBox(regenIfZero?: boolean, forceRegen?: boolean): default
A cached alias for element.getBoundingClientRect(). Boxes are updated or regenerated as ancestors shift.
Parameters
- regenIfZero: boolean = true
- forceRegen: boolean = false
Returns default
- Defined in src/game/ui/component/Component.ts:533

getChildren

getChildren<C>(selector?: string): Stream<C>
Returns a stream of this component's child components. Child elements that don't have associated components will be undefined.
Type Parameters
- C extends default<HTMLElement> = default<HTMLElement>
Parameters
- Optional selector: string
  
  A selector that each element must match to be included in the result stream
Returns Stream<C>
- Defined in src/game/ui/component/Component.ts:917

`Protected` getClosestDialog

getClosestDialog(): undefined | default
Returns undefined | default
- Defined in src/game/ui/component/Component.ts:1460

getDialog

getDialog<D>(): null | D
Returns this component's containing dialog, if it exists.
Type Parameters
- D extends undefined | default = undefined | default
Returns null | D
- Defined in src/game/ui/component/Component.ts:895

getIndex

getIndex(elementsOnly?: boolean): undefined | number
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
- Defined in src/game/ui/component/Component.ts:938

getMenu

getMenu<M>(): null | M
Returns this component's containing menu, if it exists.
Type Parameters
- M extends undefined | default = undefined | default
Returns null | M
- Defined in src/game/ui/component/Component.ts:888

getNthChild

getNthChild<C>(nth?: number): undefined | C
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
- Defined in src/game/ui/component/Component.ts:909

getOffset

getOffset(): {
left: number;
top: number;
}
Returns an object containing HTMLElement.offsetTop and HTMLElement.offsetLeft

Returns {
left: number;
top: number;
}
- left: number
- top: number
- Defined in src/game/ui/component/Component.ts:619

getParent

getParent<C>(): null | C
Returns this component's parent component, if it exists.
Type Parameters
- C extends undefined | default<HTMLElement> = undefined | default<HTMLElement>
Returns null | C
- Defined in src/game/ui/component/Component.ts:881

getScreen

getScreen<S>(): null | S
Returns this component's containing dialog, if it exists.
Type Parameters
- S extends undefined | default = undefined | default
Returns null | S
- Defined in src/game/ui/component/Component.ts:902

getSelectionTarget

getSelectionTarget(): default<HTMLElement>
Returns default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:763

hide

hide(): default<E>
Hides the element. If a tooltip is shown for this element, hides that as well.

Returns default<E>
- Defined in src/game/ui/component/Component.ts:852

isFocused

isFocused(): boolean
Returns boolean
- Defined in src/game/ui/component/Component.ts:739

isSelectable

isSelectable(): boolean
Returns boolean
- Defined in src/game/ui/component/Component.ts:757

isVisible

isVisible(): boolean
Returns whether the element is visible.

Returns boolean
- Defined in src/game/ui/component/Component.ts:832

matches

matches(selector: string): boolean
Parameters
- selector: string
Returns boolean
- Defined in src/game/ui/component/Component.ts:515

observe

observe(): void
Enables a intersection observe on this component and fires an observe event once when the element is first observed

Returns void
- Defined in src/game/ui/component/Component.ts:1064

`Protected` onContextMenu

onContextMenu(api: IBindHandlerApi): boolean
Parameters
- api: IBindHandlerApi
Returns boolean
- Defined in src/game/ui/component/Component.ts:1380

`Protected` onEnter

onEnter(reason: "focus" | "mouse"): void
Parameters
- reason: "focus" | "mouse"
Returns void
- Defined in src/game/ui/component/Component.ts:1393

`Protected` onLeave

onLeave(reason: "remove" | "focus" | "mouse"): void
Parameters
- reason: "remove" | "focus" | "mouse"
Returns void
- Defined in src/game/ui/component/Component.ts:1415

queryX

queryX<N>(selector: string): null | N
Type Parameters
- N extends Node = Node
Parameters
- selector: string
Returns null | N
- Defined in src/game/ui/component/Component.ts:964

queryXAll

queryXAll<N>(selector: string): N[]
Type Parameters
- N extends Node = Node
Parameters
- selector: string
Returns N[]
- Defined in src/game/ui/component/Component.ts:968

reflow

reflow(reason: string): void
Parameters
- reason: string
Returns void
- Defined in src/game/ui/component/Component.ts:1240

refreshTooltip

refreshTooltip(): void
Returns void
- Defined in src/game/ui/component/Component.ts:1111

regenerateBoxes

regenerateBoxes(descendants?: boolean): void
Forcibly regenerates the cached result of Component.getBox for this component and all descendants.
Parameters
- descendants: boolean = true
Returns void
- Defined in src/game/ui/component/Component.ts:609

registerBindHandlers

registerBindHandlers(...untilEvents: (keyof IComponentEvents)[]): void
Parameters
- Rest ...untilEvents: (keyof IComponentEvents)[]
Returns void
- Defined in src/game/ui/component/Component.ts:794
registerBindHandlers(warnIfNoHandlers: false, ...untilEvents: (keyof IComponentEvents)[]): void
Parameters
- warnIfNoHandlers: false
- Rest ...untilEvents: (keyof IComponentEvents)[]
Returns void
- Defined in src/game/ui/component/Component.ts:795

registerEventBusSubscriber

registerEventBusSubscriber(...untilEvents: (keyof IComponentEvents)[]): void
Parameters
- Rest ...untilEvents: (keyof IComponentEvents)[]
Returns void
- Defined in src/game/ui/component/Component.ts:779

remove

remove(): default<E>
Removes this element and all descendants.

Returns default<E>
- Defined in src/game/ui/component/Component.ts:1026

removeEventListener

removeEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:493

removeTooltip

removeTooltip(): void
Returns void
- Defined in src/game/ui/component/Component.ts:1117

repaint

repaint(): void
Triggers a repaint on this element.

Returns void
- Defined in src/game/ui/component/Component.ts:1236

schedule

schedule<A>(cb?: ((this: default<E>, component: default<E>, ...args: A) => any), ...args: A): default<E>
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<E>, component: default<E>, ...args: A) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>, ...args: A): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Rest ...args: A
      
      Returns any
- Rest ...args: A
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1259
schedule(cb?: ((this: default<E>, component: default<E>) => any), ...args: any[]): default<E>
Runs the given callback with the given arguments. this and the first argument are this element.
Parameters
- Optional cb: ((this: default<E>, component: default<E>) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Returns any
- Rest ...args: any[]
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1265
schedule<A>(ms: number, cb: ((this: default<E>, component: default<E>, ...args: A) => any), ...args: A): default<E>
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<E>, component: default<E>, ...args: A) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>, ...args: A): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Rest ...args: A
      
      Returns any
- Rest ...args: A
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1273
schedule(ms: number, cb?: ((this: default<E>, component: default<E>) => any), ...args: any[]): default<E>
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<E>, component: default<E>) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Returns any
- Rest ...args: any[]
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1281
schedule<A>(ms: number, debounce: number, cb: ((this: default<E>, component: default<E>, ...args: A) => any), ...args: A): default<E>
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<E>, component: default<E>, ...args: A) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>, ...args: A): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Rest ...args: A
      
      Returns any
- Rest ...args: A
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1290
schedule(ms: number, debounce: number, cb?: ((this: default<E>, component: default<E>) => any), ...args: any[]): default<E>
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<E>, component: default<E>) => any)
  
  The callback to run.
  - - (this: default<E>, component: default<E>): any
    - Parameters
      
      this: default<E>
      
      component: default<E>
      
      Returns any
- Rest ...args: any[]
  
  The arguments with which to call the callback.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1299

scrollTo

scrollTo(child?: HTMLElement | default<HTMLElement>, ms?: number): void
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
- Defined in src/game/ui/component/Component.ts:1168
scrollTo(child: undefined | HTMLElement | default<HTMLElement>, offsetTop: number, ms?: number): 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
- Defined in src/game/ui/component/Component.ts:1175

setContents

setContents(html: string, escape?: boolean): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:1076

setContextMenu

setContextMenu(): default<E>
Removes the context menu from this element.

Returns default<E>
- Defined in src/game/ui/component/Component.ts:1133
setContextMenu(generator: ((contextMenu: ContextMenu, api: IBindHandlerApi) => undefined | ContextMenu), priority?: number): default<E>
Sets the context menu for this element.
Parameters
- generator: ((contextMenu: ContextMenu, api: IBindHandlerApi) => undefined | ContextMenu)
  - - (contextMenu: ContextMenu, api: IBindHandlerApi): undefined | ContextMenu
    - Parameters
      
      contextMenu: ContextMenu
      
      api: IBindHandlerApi
      
      Returns undefined | ContextMenu
- Optional priority: number
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1137

setElement

setElement(element: E): default<E>
Warning: This method will replace the internal element backing this component.

Only call this directly after constructing the element.
Parameters
- element: E
Returns default<E>
- Defined in src/game/ui/component/Component.ts:639
setElement(elementType?: string, namespace?: SVG): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:645

setHighlight

setHighlight(highlight?: IHighlight): default<E>
Parameters
- Optional highlight: IHighlight
Returns default<E>
- Defined in src/game/ui/component/Component.ts:718

setId

setId(id: string): default<E>
Sets the ID of this component's element.
Parameters
- id: string
Returns default<E>
- Defined in src/game/ui/component/Component.ts:713

setInitialSelection

setInitialSelection(initialSelection?: boolean): default<E>
Parameters
- initialSelection: boolean = true
Returns default<E>
- Defined in src/game/ui/component/Component.ts:767

setSelectable

setSelectable(val: false | SelectableLayer): default<E>
Parameters
- val: false | SelectableLayer
Returns default<E>
- Defined in src/game/ui/component/Component.ts:743

setStyle

setStyle(property: string, value: string | number): default<E>
Parameters
- property: string
- value: string | number
Returns default<E>
- Defined in src/game/ui/component/Component.ts:727

setTooltip

setTooltip<ARGS>(initializer?: ((tooltip: default, ...args: ARGS) => any), ...args: ARGS): default<E>
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<E>
- Defined in src/game/ui/component/Component.ts:1096

show

show(): default<E>
Shows the element.

Returns default<E>
- Defined in src/game/ui/component/Component.ts:839

siblings

siblings<C>(selector?: string): Stream<C>
Returns a stream of this component's sibling components. Child elements that don't have associated components will be undefined.
Type Parameters
- C extends default<HTMLElement> = default<HTMLElement>
Parameters
- Optional selector: string
  
  A selector that each element must match to be included in the result stream
Returns Stream<C>
- Defined in src/game/ui/component/Component.ts:928

sleep

sleep(ms: number): Promise<boolean>
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>
- Defined in src/game/ui/component/Component.ts:1440

store

store(owner: default<HTMLElement>): default<E>
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
- owner: default<HTMLElement>
Returns default<E>
- Defined in src/game/ui/component/Component.ts:1056

toggle

toggle(visible?: boolean): default<E>
Toggles the visibility of this element. Internally uses show and hide.
Parameters
- visible: boolean = ...
  
  The new visiblity of this element.
Returns default<E>
- Defined in src/game/ui/component/Component.ts:866

`Static` all

all(selector: string): Stream<default<HTMLElement>>
Parameters
- selector: string
Returns Stream<default<HTMLElement>>
- Defined in src/game/ui/component/Component.ts:131

`Static` append

append(elementToMove: string | HTMLElement | default<HTMLElement>, placeToAppendTo: string | HTMLElement | default<HTMLElement>, strategy?: AppendStrategy): void
Parameters
- elementToMove: string | HTMLElement | default<HTMLElement>
- placeToAppendTo: string | HTMLElement | default<HTMLElement>
- strategy: AppendStrategy = "append"
Returns void
- Defined in src/game/ui/component/Component.ts:161

`Static` findDescendants

findDescendants(inElement: HTMLElement | default<HTMLElement>, selector: string, includeSelf?: boolean): HTMLElement[]
Parameters
- inElement: HTMLElement | default<HTMLElement>
- selector: string
- includeSelf: boolean = false
Returns HTMLElement[]
- Defined in src/game/ui/component/Component.ts:135

`Static` get

get(selector: string): undefined | default<HTMLElement>
Parameters
- selector: string
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:91
get(element: Element | default<HTMLElement>): default<HTMLElement>
Parameters
- element: Element | default<HTMLElement>
Returns default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:92
get(event: Event): default<HTMLElement>
Parameters
- event: Event
Returns default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:93
get(element: undefined | null | false | Element | default<HTMLElement>): undefined | default<HTMLElement>
Parameters
- element: undefined | null | false | Element | default<HTMLElement>
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:94
get(selector: string, create: undefined | false): undefined | default<HTMLElement>
Parameters
- selector: string
- create: undefined | false
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:95
get(element: Element | default<HTMLElement>, create: undefined | false): undefined | default<HTMLElement>
Parameters
- element: Element | default<HTMLElement>
- create: undefined | false
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:96
get(event: Event, create: undefined | false): undefined | default<HTMLElement>
Parameters
- event: Event
- create: undefined | false
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:97
get(element: undefined | null | false | Element | default<HTMLElement>, create: undefined | false): undefined | default<HTMLElement>
Parameters
- element: undefined | null | false | Element | default<HTMLElement>
- create: undefined | false
Returns undefined | default<HTMLElement>
- Defined in src/game/ui/component/Component.ts:98
get<C>(selector: string): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- selector: string
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:99
get<C>(element: Element | C): C
Type Parameters
- C extends default<HTMLElement>
Parameters
- element: Element | C
Returns C
- Defined in src/game/ui/component/Component.ts:100
get<C>(event: Event): C
Type Parameters
- C extends default<HTMLElement>
Parameters
- event: Event
Returns C
- Defined in src/game/ui/component/Component.ts:101
get<C>(element: undefined | null | false | Element | C): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- element: undefined | null | false | Element | C
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:102
get<C>(selector: string, create: undefined | false): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- selector: string
- create: undefined | false
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:103
get<C>(element: Element | C, create: undefined | false): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- element: Element | C
- create: undefined | false
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:104
get<C>(event: Event, create: undefined | false): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- event: Event
- create: undefined | false
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:105
get<C>(element: undefined | null | false | Element | C, create: undefined | false): undefined | C
Type Parameters
- C extends default<HTMLElement>
Parameters
- element: undefined | null | false | Element | C
- create: undefined | false
Returns undefined | C
- Defined in src/game/ui/component/Component.ts:106

`Static` getSelectableLayer

getSelectableLayer(element: HTMLElement | default<HTMLElement>): number | false
Parameters
- element: HTMLElement | default<HTMLElement>
Returns number | false
- Defined in src/game/ui/component/Component.ts:146

`Static` remove

remove(elementToRemove: null | string | Element | ChildNode | default<HTMLElement>, force?: boolean): void
Parameters
- elementToRemove: null | string | Element | ChildNode | default<HTMLElement>
- force: boolean = false
Returns void
- Defined in src/game/ui/component/Component.ts:254

Class default<E>

Type Parameters

E extends HTMLElement = HTMLElement

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

E extends HTMLElement = HTMLElement

Parameters

Optional elementType: string

Optional namespace: SVG

Returns default<E>

Properties

Readonly attributes

Readonly classes

Readonly data

Protected entered

Readonly event

Optional observing

Optional removed

Readonly style

Accessors

childCount

Returns number

dataset

Returns DOMStringMap

element

Returns E

selectable

Returns false | SelectableLayer

Methods

addEventListener

Type Parameters

K extends keyof HTMLElementEventMap

Parameters

type: K

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

Parameters

this: HTMLElement

ev: HTMLElementEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns default<E>

append

Parameters

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

Returns default<E>

Parameters

appendStrategy: AppendStrategy

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

Returns default<E>

appendTo

Parameters

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

Optional appendStrategy: AppendStrategy

Returns default<E>

closest

Parameters

selector: string

Returns null | Element

contains

Parameters

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

Returns boolean

deregisterBindHandlers

Returns void

deregisterEventBusSubscriber

Returns void

dump

Returns default<E>

Parameters

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

Parameters

element: HTMLElement

Optional component: default<HTMLElement>

`Optional` elementType: string

`Optional` namespace: SVG

`Readonly` attributes

`Readonly` classes

`Readonly` data

`Protected` entered

`Readonly` event

`Optional` observing

`Optional` removed

`Readonly` style

`Optional` options: boolean | AddEventListenerOptions

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

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

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

`Optional` appendStrategy: AppendStrategy

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

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

`Optional` component: default<HTMLElement>

`Optional` selector: string

`Protected` getClosestDialog

Returns {
left: number;
top: number;
}