@genesislcap/foundation-utils 14.225.1 → 14.225.2-alpha-a51f60c.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/custom-elements.json +531 -531
- package/dist/dts/error/errorMap.d.ts.map +1 -1
- package/dist/dts/mixins/lifecycle/lifecycle.d.ts +51 -29
- package/dist/dts/mixins/lifecycle/lifecycle.d.ts.map +1 -1
- package/dist/dts/mixins/pendingState/pendingState.d.ts +45 -29
- package/dist/dts/mixins/pendingState/pendingState.d.ts.map +1 -1
- package/dist/dts/observer/observer.d.ts.map +1 -1
- package/dist/dts/promise/resolveAfter.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +1 -1
- package/dist/esm/mixins/lifecycle/lifecycle.js +5 -5
- package/dist/esm/mixins/pendingState/pendingState.js +2 -2
- package/dist/esm/uuid/uuid.js +2 -2
- package/dist/foundation-utils.api.json +1109 -270
- package/dist/foundation-utils.d.ts +93 -58
- package/docs/api/foundation-utils.createerrormap.md +14 -1
- package/docs/api/foundation-utils.createobserver.md +5 -1
- package/docs/api/foundation-utils.getfontmixin.md +16 -1
- package/docs/api/foundation-utils.iniframe.md +7 -1
- package/docs/api/foundation-utils.insertdocumentcssrule.md +15 -1
- package/docs/api/foundation-utils.insertdocumentlink.md +12 -1
- package/docs/api/foundation-utils.insymphonydesktop.md +7 -1
- package/docs/api/foundation-utils.isdev.md +5 -1
- package/docs/api/foundation-utils.lifecyclemixin.md +56 -30
- package/docs/api/foundation-utils.loadfontfaces.md +13 -1
- package/docs/api/foundation-utils.md +14 -14
- package/docs/api/foundation-utils.openpopup.md +17 -1
- package/docs/api/foundation-utils.pendingstate.md +57 -30
- package/docs/api/foundation-utils.resolveafter.md +12 -1
- package/docs/api/foundation-utils.respondtovisibility.md +13 -1
- package/docs/{api-report.md → api-report.md.api.md} +93 -58
- package/package.json +11 -11
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [LifecycleMixin](./foundation-utils.lifecyclemixin.md)
|
4
4
|
|
5
|
-
## LifecycleMixin
|
5
|
+
## LifecycleMixin() function
|
6
6
|
|
7
7
|
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
8
8
|
>
|
@@ -45,11 +45,15 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
45
45
|
readonly offsetTop: number;
|
46
46
|
readonly offsetWidth: number;
|
47
47
|
outerText: string;
|
48
|
+
popover: string;
|
48
49
|
spellcheck: boolean;
|
49
50
|
title: string;
|
50
51
|
translate: boolean;
|
51
52
|
attachInternals(): ElementInternals;
|
52
53
|
click(): void;
|
54
|
+
hidePopover(): void;
|
55
|
+
showPopover(): void;
|
56
|
+
togglePopover(force?: boolean): boolean;
|
53
57
|
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
54
58
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
55
59
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
@@ -78,9 +82,12 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
78
82
|
slot: string;
|
79
83
|
readonly tagName: string;
|
80
84
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
85
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
81
86
|
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
82
87
|
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
88
|
+
closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
|
83
89
|
closest<E extends Element = Element>(selectors: string): E;
|
90
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
84
91
|
getAttribute(qualifiedName: string): string;
|
85
92
|
getAttributeNS(namespace: string, localName: string): string;
|
86
93
|
getAttributeNames(): string[];
|
@@ -89,11 +96,14 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
89
96
|
getBoundingClientRect(): DOMRect;
|
90
97
|
getClientRects(): DOMRectList;
|
91
98
|
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
92
|
-
getElementsByTagName<
|
93
|
-
getElementsByTagName<
|
99
|
+
getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
|
100
|
+
getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
|
101
|
+
getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
|
102
|
+
getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
|
94
103
|
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
95
104
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
96
105
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
106
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
97
107
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
98
108
|
hasAttribute(qualifiedName: string): boolean;
|
99
109
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
@@ -150,24 +160,24 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
150
160
|
normalize(): void;
|
151
161
|
removeChild<T_3 extends Node>(child: T_3): T_3;
|
152
162
|
replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
|
153
|
-
readonly
|
154
|
-
readonly
|
155
|
-
readonly
|
156
|
-
readonly
|
157
|
-
readonly
|
158
|
-
readonly
|
159
|
-
readonly
|
160
|
-
readonly
|
161
|
-
readonly
|
162
|
-
readonly
|
163
|
-
readonly
|
164
|
-
readonly
|
165
|
-
readonly
|
166
|
-
readonly
|
167
|
-
readonly
|
168
|
-
readonly
|
169
|
-
readonly
|
170
|
-
readonly
|
163
|
+
readonly ELEMENT_NODE: 1;
|
164
|
+
readonly ATTRIBUTE_NODE: 2;
|
165
|
+
readonly TEXT_NODE: 3;
|
166
|
+
readonly CDATA_SECTION_NODE: 4;
|
167
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
168
|
+
readonly ENTITY_NODE: 6;
|
169
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
170
|
+
readonly COMMENT_NODE: 8;
|
171
|
+
readonly DOCUMENT_NODE: 9;
|
172
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
173
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
174
|
+
readonly NOTATION_NODE: 12;
|
175
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
176
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
177
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
178
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
179
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
180
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
171
181
|
dispatchEvent(event: Event): boolean;
|
172
182
|
ariaAtomic: string;
|
173
183
|
ariaAutoComplete: string;
|
@@ -175,9 +185,9 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
175
185
|
ariaChecked: string;
|
176
186
|
ariaColCount: string;
|
177
187
|
ariaColIndex: string;
|
178
|
-
ariaColIndexText: string;
|
179
188
|
ariaColSpan: string;
|
180
189
|
ariaCurrent: string;
|
190
|
+
ariaDescription: string;
|
181
191
|
ariaDisabled: string;
|
182
192
|
ariaExpanded: string;
|
183
193
|
ariaHasPopup: string;
|
@@ -199,7 +209,6 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
199
209
|
ariaRoleDescription: string;
|
200
210
|
ariaRowCount: string;
|
201
211
|
ariaRowIndex: string;
|
202
|
-
ariaRowIndexText: string;
|
203
212
|
ariaRowSpan: string;
|
204
213
|
ariaSelected: string;
|
205
214
|
ariaSetSize: string;
|
@@ -224,17 +233,19 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
224
233
|
readonly lastElementChild: Element;
|
225
234
|
append(...nodes: (string | Node)[]): void;
|
226
235
|
prepend(...nodes: (string | Node)[]): void;
|
227
|
-
querySelector<
|
228
|
-
querySelector<
|
236
|
+
querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
|
237
|
+
querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
|
238
|
+
querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
|
239
|
+
querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
|
229
240
|
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
230
|
-
querySelectorAll<
|
231
|
-
querySelectorAll<
|
241
|
+
querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
|
242
|
+
querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
|
243
|
+
querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
|
244
|
+
querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
|
232
245
|
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
233
246
|
replaceChildren(...nodes: (string | Node)[]): void;
|
234
247
|
readonly assignedSlot: HTMLSlotElement;
|
235
|
-
|
236
|
-
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
237
|
-
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
248
|
+
readonly attributeStyleMap: StylePropertyMap;
|
238
249
|
readonly style: CSSStyleDeclaration;
|
239
250
|
contentEditable: string;
|
240
251
|
enterKeyHint: string;
|
@@ -247,6 +258,7 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
247
258
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
248
259
|
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
249
260
|
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
261
|
+
onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
250
262
|
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
251
263
|
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
252
264
|
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -255,7 +267,9 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
255
267
|
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
256
268
|
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
257
269
|
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
270
|
+
oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
258
271
|
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
272
|
+
oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
259
273
|
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
260
274
|
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
261
275
|
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
@@ -288,6 +302,7 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
288
302
|
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
289
303
|
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
290
304
|
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
305
|
+
onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
291
306
|
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
292
307
|
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
293
308
|
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -304,6 +319,7 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
304
319
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
305
320
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
306
321
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
322
|
+
onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
|
307
323
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
308
324
|
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
309
325
|
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -341,6 +357,16 @@ LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
341
357
|
} & T
|
342
358
|
```
|
343
359
|
|
360
|
+
## Parameters
|
361
|
+
|
362
|
+
| Parameter | Type | Description |
|
363
|
+
| --- | --- | --- |
|
364
|
+
| Base | T | |
|
365
|
+
|
366
|
+
**Returns:**
|
367
|
+
|
368
|
+
{ new (...args: any\[\]): { "\_\_\#1@\#\_container": Container; "\_\_\#1@\#\_latestTokenCode": string; "\_\_\#1@\#\_hasFirstLoaded": boolean; "\_\_\#1@\#\_cleanupTimeout": NodeJS.Timeout; "\_\_\#1@\#\_shouldForceLifecycle": boolean; cloneNode(deep?: boolean): Node; deepClone(): Node; readonly shouldRunDisconnect: boolean; readonly shouldRunConnect: boolean; "\_\_\#1@\#\_blockLifecycleDueToTokenChange"(lifecycleType: Lifecycletype): boolean; "\_\_\#1@\#\_tryFindContainingLayout"(e: Element): Container; connectedCallback(): void; readonly $fastController: import("@microsoft/fast-element").Controller; $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean \| void; disconnectedCallback(): void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; accessKey: string; readonly accessKeyLabel: string; autocapitalize: string; dir: string; draggable: boolean; hidden: boolean; inert: boolean; innerText: string; lang: string; readonly offsetHeight: number; readonly offsetLeft: number; readonly offsetParent: Element; readonly offsetTop: number; readonly offsetWidth: number; outerText: string; popover: string; spellcheck: boolean; title: string; translate: boolean; attachInternals(): ElementInternals; click(): void; hidePopover(): void; showPopover(): void; togglePopover(force?: boolean): boolean; addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\]) => any, options?: boolean \| AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions): void; removeEventListener<K\_1 extends keyof HTMLElementEventMap>(type: K\_1, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\_1\]) => any, options?: boolean \| EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| EventListenerOptions): void; readonly attributes: NamedNodeMap; readonly classList: DOMTokenList; className: string; readonly clientHeight: number; readonly clientLeft: number; readonly clientTop: number; readonly clientWidth: number; id: string; readonly localName: string; readonly namespaceURI: string; onfullscreenchange: (this: Element, ev: Event) => any; onfullscreenerror: (this: Element, ev: Event) => any; outerHTML: string; readonly ownerDocument: Document; readonly part: DOMTokenList; readonly prefix: string; readonly scrollHeight: number; scrollLeft: number; scrollTop: number; readonly scrollWidth: number; readonly shadowRoot: ShadowRoot; slot: string; readonly tagName: string; attachShadow(init: ShadowRootInit): ShadowRoot; checkVisibility(options?: CheckVisibilityOptions): boolean; closest<K\_2 extends keyof HTMLElementTagNameMap>(selector: K\_2): HTMLElementTagNameMap\[K\_2\]; closest<K\_3 extends keyof SVGElementTagNameMap>(selector: K\_3): SVGElementTagNameMap\[K\_3\]; closest<K\_4 extends keyof MathMLElementTagNameMap>(selector: K\_4): MathMLElementTagNameMap\[K\_4\]; closest<E extends Element = Element>(selectors: string): E; computedStyleMap(): StylePropertyMapReadOnly; getAttribute(qualifiedName: string): string; getAttributeNS(namespace: string, localName: string): string; getAttributeNames(): string\[\]; getAttributeNode(qualifiedName: string): Attr; getAttributeNodeNS(namespace: string, localName: string): Attr; getBoundingClientRect(): DOMRect; getClientRects(): DOMRectList; getElementsByClassName(classNames: string): HTMLCollectionOf<Element>; getElementsByTagName<K\_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K\_5): HTMLCollectionOf<HTMLElementTagNameMap\[K\_5\]>; getElementsByTagName<K\_6 extends keyof SVGElementTagNameMap>(qualifiedName: K\_6): HTMLCollectionOf<SVGElementTagNameMap\[K\_6\]>; getElementsByTagName<K\_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K\_7): HTMLCollectionOf<MathMLElementTagNameMap\[K\_7\]>; getElementsByTagName<K\_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K\_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap\[K\_8\]>; getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>; getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>; hasAttribute(qualifiedName: string): boolean; hasAttributeNS(namespace: string, localName: string): boolean; hasAttributes(): boolean; hasPointerCapture(pointerId: number): boolean; insertAdjacentElement(where: InsertPosition, element: Element): Element; insertAdjacentHTML(position: InsertPosition, text: string): void; insertAdjacentText(where: InsertPosition, data: string): void; matches(selectors: string): boolean; releasePointerCapture(pointerId: number): void; removeAttribute(qualifiedName: string): void; removeAttributeNS(namespace: string, localName: string): void; removeAttributeNode(attr: Attr): Attr; requestFullscreen(options?: FullscreenOptions): Promise<void>; requestPointerLock(): void; scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; scrollIntoView(arg?: boolean \| ScrollIntoViewOptions): void; scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; setAttribute(qualifiedName: string, value: string): void; setAttributeNS(namespace: string, qualifiedName: string, value: string): void; setAttributeNode(attr: Attr): Attr; setAttributeNodeNS(attr: Attr): Attr; setPointerCapture(pointerId: number): void; toggleAttribute(qualifiedName: string, force?: boolean): boolean; webkitMatchesSelector(selectors: string): boolean; readonly baseURI: string; readonly childNodes: NodeListOf<ChildNode>; readonly firstChild: ChildNode; readonly isConnected: boolean; readonly lastChild: ChildNode; readonly nextSibling: ChildNode; readonly nodeName: string; readonly nodeType: number; nodeValue: string; readonly parentElement: HTMLElement; readonly parentNode: ParentNode; readonly previousSibling: ChildNode; textContent: string; appendChild<T\_1 extends Node>(node: T\_1): T\_1; compareDocumentPosition(other: Node): number; contains(other: Node): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore<T\_2 extends Node>(node: T\_2, child: Node): T\_2; isDefaultNamespace(namespace: string): boolean; isEqualNode(otherNode: Node): boolean; isSameNode(otherNode: Node): boolean; lookupNamespaceURI(prefix: string): string; lookupPrefix(namespace: string): string; normalize(): void; removeChild<T\_3 extends Node>(child: T\_3): T\_3; replaceChild<T\_4 extends Node>(node: Node, child: T\_4): T\_4; readonly ELEMENT\_NODE: 1; readonly ATTRIBUTE\_NODE: 2; readonly TEXT\_NODE: 3; readonly CDATA\_SECTION\_NODE: 4; readonly ENTITY\_REFERENCE\_NODE: 5; readonly ENTITY\_NODE: 6; readonly PROCESSING\_INSTRUCTION\_NODE: 7; readonly COMMENT\_NODE: 8; readonly DOCUMENT\_NODE: 9; readonly DOCUMENT\_TYPE\_NODE: 10; readonly DOCUMENT\_FRAGMENT\_NODE: 11; readonly NOTATION\_NODE: 12; readonly DOCUMENT\_POSITION\_DISCONNECTED: 1; readonly DOCUMENT\_POSITION\_PRECEDING: 2; readonly DOCUMENT\_POSITION\_FOLLOWING: 4; readonly DOCUMENT\_POSITION\_CONTAINS: 8; readonly DOCUMENT\_POSITION\_CONTAINED\_BY: 16; readonly DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC: 32; dispatchEvent(event: Event): boolean; ariaAtomic: string; ariaAutoComplete: string; ariaBusy: string; ariaChecked: string; ariaColCount: string; ariaColIndex: string; ariaColSpan: string; ariaCurrent: string; ariaDescription: string; ariaDisabled: string; ariaExpanded: string; ariaHasPopup: string; ariaHidden: string; ariaInvalid: string; ariaKeyShortcuts: string; ariaLabel: string; ariaLevel: string; ariaLive: string; ariaModal: string; ariaMultiLine: string; ariaMultiSelectable: string; ariaOrientation: string; ariaPlaceholder: string; ariaPosInSet: string; ariaPressed: string; ariaReadOnly: string; ariaRequired: string; ariaRoleDescription: string; ariaRowCount: string; ariaRowIndex: string; ariaRowSpan: string; ariaSelected: string; ariaSetSize: string; ariaSort: string; ariaValueMax: string; ariaValueMin: string; ariaValueNow: string; ariaValueText: string; role: string; animate(keyframes: Keyframe\[\] \| PropertyIndexedKeyframes, options?: number \| KeyframeAnimationOptions): Animation; getAnimations(options?: GetAnimationsOptions): Animation\[\]; after(...nodes: (string \| Node)\[\]): void; before(...nodes: (string \| Node)\[\]): void; remove(): void; replaceWith(...nodes: (string \| Node)\[\]): void; innerHTML: string; readonly nextElementSibling: Element; readonly previousElementSibling: Element; readonly childElementCount: number; readonly children: HTMLCollection; readonly firstElementChild: Element; readonly lastElementChild: Element; append(...nodes: (string \| Node)\[\]): void; prepend(...nodes: (string \| Node)\[\]): void; querySelector<K\_9 extends keyof HTMLElementTagNameMap>(selectors: K\_9): HTMLElementTagNameMap\[K\_9\]; querySelector<K\_10 extends keyof SVGElementTagNameMap>(selectors: K\_10): SVGElementTagNameMap\[K\_10\]; querySelector<K\_11 extends keyof MathMLElementTagNameMap>(selectors: K\_11): MathMLElementTagNameMap\[K\_11\]; querySelector<K\_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_12): HTMLElementDeprecatedTagNameMap\[K\_12\]; querySelector<E\_1 extends Element = Element>(selectors: string): E\_1; querySelectorAll<K\_13 extends keyof HTMLElementTagNameMap>(selectors: K\_13): NodeListOf<HTMLElementTagNameMap\[K\_13\]>; querySelectorAll<K\_14 extends keyof SVGElementTagNameMap>(selectors: K\_14): NodeListOf<SVGElementTagNameMap\[K\_14\]>; querySelectorAll<K\_15 extends keyof MathMLElementTagNameMap>(selectors: K\_15): NodeListOf<MathMLElementTagNameMap\[K\_15\]>; querySelectorAll<K\_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_16): NodeListOf<HTMLElementDeprecatedTagNameMap\[K\_16\]>; querySelectorAll<E\_2 extends Element = Element>(selectors: string): NodeListOf<E\_2>; replaceChildren(...nodes: (string \| Node)\[\]): void; readonly assignedSlot: HTMLSlotElement; readonly attributeStyleMap: StylePropertyMap; readonly style: CSSStyleDeclaration; contentEditable: string; enterKeyHint: string; inputMode: string; readonly isContentEditable: boolean; onabort: (this: GlobalEventHandlers, ev: UIEvent) => any; onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any; onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any; onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any; oncancel: (this: GlobalEventHandlers, ev: Event) => any; oncanplay: (this: GlobalEventHandlers, ev: Event) => any; oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any; onchange: (this: GlobalEventHandlers, ev: Event) => any; onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onclose: (this: GlobalEventHandlers, ev: Event) => any; oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any; oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; oncuechange: (this: GlobalEventHandlers, ev: Event) => any; oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any; ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any; ondurationchange: (this: GlobalEventHandlers, ev: Event) => any; onemptied: (this: GlobalEventHandlers, ev: Event) => any; onended: (this: GlobalEventHandlers, ev: Event) => any; onerror: OnErrorEventHandlerNonNull; onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any; onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any; ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; oninput: (this: GlobalEventHandlers, ev: Event) => any; oninvalid: (this: GlobalEventHandlers, ev: Event) => any; onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onload: (this: GlobalEventHandlers, ev: Event) => any; onloadeddata: (this: GlobalEventHandlers, ev: Event) => any; onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any; onloadstart: (this: GlobalEventHandlers, ev: Event) => any; onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any; onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; onpause: (this: GlobalEventHandlers, ev: Event) => any; onplay: (this: GlobalEventHandlers, ev: Event) => any; onplaying: (this: GlobalEventHandlers, ev: Event) => any; onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any; onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any; onratechange: (this: GlobalEventHandlers, ev: Event) => any; onreset: (this: GlobalEventHandlers, ev: Event) => any; onresize: (this: GlobalEventHandlers, ev: UIEvent) => any; onscroll: (this: GlobalEventHandlers, ev: Event) => any; onscrollend: (this: GlobalEventHandlers, ev: Event) => any; onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any; onseeked: (this: GlobalEventHandlers, ev: Event) => any; onseeking: (this: GlobalEventHandlers, ev: Event) => any; onselect: (this: GlobalEventHandlers, ev: Event) => any; onselectionchange: (this: GlobalEventHandlers, ev: Event) => any; onselectstart: (this: GlobalEventHandlers, ev: Event) => any; onslotchange: (this: GlobalEventHandlers, ev: Event) => any; onstalled: (this: GlobalEventHandlers, ev: Event) => any; onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any; onsuspend: (this: GlobalEventHandlers, ev: Event) => any; ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any; ontoggle: (this: GlobalEventHandlers, ev: Event) => any; ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any; onvolumechange: (this: GlobalEventHandlers, ev: Event) => any; onwaiting: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any; onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any; onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any; autofocus: boolean; readonly dataset: DOMStringMap; nonce?: string; tabIndex: number; blur(): void; focus(options?: FocusOptions): void; }; } & T
|
369
|
+
|
344
370
|
## Remarks
|
345
371
|
|
346
372
|
These can be used to control what lifecycle functionality is ran when the elements are part of a custom layout. The class itself handles all events
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [loadFontFaces](./foundation-utils.loadfontfaces.md)
|
4
4
|
|
5
|
-
## loadFontFaces
|
5
|
+
## loadFontFaces() function
|
6
6
|
|
7
7
|
Loads font faces by inserting a style element with the specified font face rules into the document.
|
8
8
|
|
@@ -11,3 +11,15 @@ Loads font faces by inserting a style element with the specified font face rules
|
|
11
11
|
```typescript
|
12
12
|
loadFontFaces: (fontFaceRules: string, styleElementId: string) => void
|
13
13
|
```
|
14
|
+
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| fontFaceRules | string | The CSS rules for the font faces. |
|
20
|
+
| styleElementId | string | The ID of the style element to insert into the document. |
|
21
|
+
|
22
|
+
**Returns:**
|
23
|
+
|
24
|
+
void
|
25
|
+
|
@@ -27,17 +27,31 @@
|
|
27
27
|
| Function | Description |
|
28
28
|
| --- | --- |
|
29
29
|
| [assureDesignSystem(module)](./foundation-utils.assuredesignsystem.md) | assureDesignSystem. |
|
30
|
+
| [createErrorMap(logger)](./foundation-utils.createerrormap.md) | A factory to create the error map. |
|
30
31
|
| [createLogger(name, options)](./foundation-utils.createlogger.md) | Creates a logger with the given name and options. |
|
32
|
+
| [createObserver()](./foundation-utils.createobserver.md) | Creates a new event observer instance. |
|
31
33
|
| [customNumberParser(value)](./foundation-utils.customnumberparser.md) | A Default Number Parser for deserializing objects. |
|
32
34
|
| [formatDateTimestamp(timestamp)](./foundation-utils.formatdatetimestamp.md) | Formats \[DATE\] UNIX Timestamps (without time) to readable strings |
|
33
35
|
| [formatDateTimeTimestamp(timestamp)](./foundation-utils.formatdatetimetimestamp.md) | Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings |
|
34
36
|
| [formatTimestamp(timestamp, withTime)](./foundation-utils.formattimestamp.md) | Formats \[DATE\|DATETIME\] Unix Timestamps to readable strings |
|
35
37
|
| [getDateFormatter(locale, options)](./foundation-utils.getdateformatter.md) | |
|
38
|
+
| [getFontMixin(family, style, weight)](./foundation-utils.getfontmixin.md) | Generates a CSS mixin for the specified font family, style, and weight. |
|
36
39
|
| [getNumberFormatter(format, locale)](./foundation-utils.getnumberformatter.md) | |
|
40
|
+
| [inIFrame()](./foundation-utils.iniframe.md) | Returns a boolean value indicating whether the current window is inside an iframe. |
|
41
|
+
| [insertDocumentCSSRule(cssRule, styleElementId)](./foundation-utils.insertdocumentcssrule.md) | Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID. Returns a function that can be called to remove the rule from the document. |
|
42
|
+
| [insertDocumentLink(href)](./foundation-utils.insertdocumentlink.md) | Inserts a CSS link into the document if it doesn't already exist. |
|
43
|
+
| [inSymphonyDesktop()](./foundation-utils.insymphonydesktop.md) | Returns a boolean value indicating whether the user is running the Symphony desktop app. |
|
44
|
+
| [isDev()](./foundation-utils.isdev.md) | Determines if the current environment is a development environment. |
|
37
45
|
| [JSONReplacer(key, value)](./foundation-utils.jsonreplacer.md) | JSON replacer function. |
|
38
46
|
| [JSONReviver(key, value)](./foundation-utils.jsonreviver.md) | JSON reviver function. |
|
47
|
+
| [LifecycleMixin(Base)](./foundation-utils.lifecyclemixin.md) | **_(BETA)_** Mixin class to expose <code>shouldRunConnect</code> and <code>shouldRunDisconnect</code> |
|
48
|
+
| [loadFontFaces(fontFaceRules, styleElementId)](./foundation-utils.loadfontfaces.md) | Loads font faces by inserting a style element with the specified font face rules into the document. |
|
49
|
+
| [openPopup(urlNavigate, target, popUpWidth, popUpHeight)](./foundation-utils.openpopup.md) | Opens a new browser window with the specified URL, target, width, and height. |
|
50
|
+
| [PendingState(Base)](./foundation-utils.pendingstate.md) | The <code>PendingState</code> mixin. |
|
39
51
|
| [reactive(object, deep)](./foundation-utils.reactive.md) | **_(BETA)_** Converts a plain object to a reactive, observable object. |
|
40
52
|
| [renderOnChange(target, name)](./foundation-utils.renderonchange.md) | Defines a property changed handler that calls a render() method on the target as an internal observation enhancement. |
|
53
|
+
| [resolveAfter(ms, valueCreator)](./foundation-utils.resolveafter.md) | Resolve a promise after a timeout. |
|
54
|
+
| [respondToVisibility(element, callback)](./foundation-utils.respondtovisibility.md) | Setup an <code>IntersectionObserver</code> which will activate a callback function when an element becomes visible on screen |
|
41
55
|
| [sync(binding, conversionType, eventName, keyAttr)](./foundation-utils.sync.md) | Creates a synchronization directive that binds a data source to an HTML element, |
|
42
56
|
| [toElementStyles(styles)](./foundation-utils.toelementstyles.md) | toElementStyles. |
|
43
57
|
| [visitObject(object, deep, visitor, data, traversed)](./foundation-utils.visitobject.md) | **_(BETA)_** Visit object utility. |
|
@@ -75,8 +89,6 @@
|
|
75
89
|
| --- | --- |
|
76
90
|
| [activeColorScheme](./foundation-utils.activecolorscheme.md) | A design token that represents the active color scheme (light or dark). |
|
77
91
|
| [API\_HOST](./foundation-utils.api_host.md) | The Genesis Server URL (WebSocket or HTTP). |
|
78
|
-
| [createErrorMap](./foundation-utils.createerrormap.md) | A factory to create the error map. |
|
79
|
-
| [createObserver](./foundation-utils.createobserver.md) | Creates a new event observer instance. |
|
80
92
|
| [DEFAULT\_ORGANISATION](./foundation-utils.default_organisation.md) | The default Organisation value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
|
81
93
|
| [DEFAULT\_PASSWORD](./foundation-utils.default_password.md) | The default Password value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
|
82
94
|
| [DEFAULT\_USER](./foundation-utils.default_user.md) | The default Username value, used in auth/login flow \[<code>genesislcap-foundation-login</code>\](https://link-to-docs). |
|
@@ -85,25 +97,13 @@
|
|
85
97
|
| [defaultLoggerOptions](./foundation-utils.defaultloggeroptions.md) | The default logger options. |
|
86
98
|
| [FORCE\_HTTP](./foundation-utils.force_http.md) | The path to a JSON config file for the HTTP mode. |
|
87
99
|
| [GENESIS\_SOCKET\_URL](./foundation-utils.genesis_socket_url.md) | Genesis Socket URL |
|
88
|
-
| [getFontMixin](./foundation-utils.getfontmixin.md) | Generates a CSS mixin for the specified font family, style, and weight. |
|
89
100
|
| [HTTP\_CONFIG](./foundation-utils.http_config.md) | Configuration settings for HTTP, used in http connect flow \[<code>genesislcap-foundation-comms.HttpConnectConfig</code>\](https://link-to-docs). |
|
90
|
-
| [inIFrame](./foundation-utils.iniframe.md) | Returns a boolean value indicating whether the current window is inside an iframe. |
|
91
|
-
| [insertDocumentCSSRule](./foundation-utils.insertdocumentcssrule.md) | Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID. Returns a function that can be called to remove the rule from the document. |
|
92
|
-
| [insertDocumentLink](./foundation-utils.insertdocumentlink.md) | Inserts a CSS link into the document if it doesn't already exist. |
|
93
|
-
| [inSymphonyDesktop](./foundation-utils.insymphonydesktop.md) | Returns a boolean value indicating whether the user is running the Symphony desktop app. |
|
94
|
-
| [isDev](./foundation-utils.isdev.md) | Determines if the current environment is a development environment. |
|
95
101
|
| [JSONSerializer](./foundation-utils.jsonserializer.md) | A DI token for the JSON serializer. |
|
96
102
|
| [layoutCacheDocument](./foundation-utils.layoutcachedocument.md) | Stored on the layout's internal cache to signify that the document is not part of the DOM |
|
97
|
-
| [LifecycleMixin](./foundation-utils.lifecyclemixin.md) | **_(BETA)_** Mixin class to expose <code>shouldRunConnect</code> and <code>shouldRunDisconnect</code> |
|
98
|
-
| [loadFontFaces](./foundation-utils.loadfontfaces.md) | Loads font faces by inserting a style element with the specified font face rules into the document. |
|
99
103
|
| [logger](./foundation-utils.logger.md) | Logger for the foundation-utils package |
|
100
|
-
| [openPopup](./foundation-utils.openpopup.md) | Opens a new browser window with the specified URL, target, width, and height. |
|
101
|
-
| [PendingState](./foundation-utils.pendingstate.md) | The <code>PendingState</code> mixin. |
|
102
104
|
| [POPUP\_DEFAULT\_HEIGHT](./foundation-utils.popup_default_height.md) | The default height (in pixels) for pop-up windows. |
|
103
105
|
| [POPUP\_DEFAULT\_WIDTH](./foundation-utils.popup_default_width.md) | The default width (in pixels) for pop-up windows. |
|
104
|
-
| [resolveAfter](./foundation-utils.resolveafter.md) | Resolve a promise after a timeout. |
|
105
106
|
| [ResourceType](./foundation-utils.resourcetype.md) | An object that defines two resource types: "local" and "remote". |
|
106
|
-
| [respondToVisibility](./foundation-utils.respondtovisibility.md) | Setup an <code>IntersectionObserver</code> which will activate a callback function when an element becomes visible on screen |
|
107
107
|
| [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md) | A DI token used to obtain a <code>ServerRowDTOMapper</code> instance. |
|
108
108
|
| [SOCKET\_EXT](./foundation-utils.socket_ext.md) | The sub-path used for WebSocket connections when API\_HOST is not set |
|
109
109
|
| [TypeRampValues](./foundation-utils.typerampvalues.md) | An object containing type ramp values. |
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [openPopup](./foundation-utils.openpopup.md)
|
4
4
|
|
5
|
-
## openPopup
|
5
|
+
## openPopup() function
|
6
6
|
|
7
7
|
Opens a new browser window with the specified URL, target, width, and height.
|
8
8
|
|
@@ -11,3 +11,19 @@ Opens a new browser window with the specified URL, target, width, and height.
|
|
11
11
|
```typescript
|
12
12
|
openPopup: (urlNavigate: string, target: string, popUpWidth?: number, popUpHeight?: number) => Window
|
13
13
|
```
|
14
|
+
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| urlNavigate | string | The URL to navigate to. |
|
20
|
+
| target | string | The name of the new window. |
|
21
|
+
| popUpWidth | number | _(Optional)_ The width of the new window (optional). |
|
22
|
+
| popUpHeight | number | _(Optional)_ The height of the new window (optional). |
|
23
|
+
|
24
|
+
**Returns:**
|
25
|
+
|
26
|
+
Window
|
27
|
+
|
28
|
+
A reference to the new window.
|
29
|
+
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [PendingState](./foundation-utils.pendingstate.md)
|
4
4
|
|
5
|
-
## PendingState
|
5
|
+
## PendingState() function
|
6
6
|
|
7
7
|
The `PendingState` mixin.
|
8
8
|
|
@@ -36,11 +36,15 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
36
36
|
readonly offsetTop: number;
|
37
37
|
readonly offsetWidth: number;
|
38
38
|
outerText: string;
|
39
|
+
popover: string;
|
39
40
|
spellcheck: boolean;
|
40
41
|
title: string;
|
41
42
|
translate: boolean;
|
42
43
|
attachInternals(): ElementInternals;
|
43
44
|
click(): void;
|
45
|
+
hidePopover(): void;
|
46
|
+
showPopover(): void;
|
47
|
+
togglePopover(force?: boolean): boolean;
|
44
48
|
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
45
49
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
46
50
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
@@ -69,9 +73,12 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
69
73
|
slot: string;
|
70
74
|
readonly tagName: string;
|
71
75
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
76
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
72
77
|
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
73
78
|
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
79
|
+
closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
|
74
80
|
closest<E extends Element = Element>(selectors: string): E;
|
81
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
75
82
|
getAttribute(qualifiedName: string): string;
|
76
83
|
getAttributeNS(namespace: string, localName: string): string;
|
77
84
|
getAttributeNames(): string[];
|
@@ -80,11 +87,14 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
80
87
|
getBoundingClientRect(): DOMRect;
|
81
88
|
getClientRects(): DOMRectList;
|
82
89
|
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
83
|
-
getElementsByTagName<
|
84
|
-
getElementsByTagName<
|
90
|
+
getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
|
91
|
+
getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
|
92
|
+
getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
|
93
|
+
getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
|
85
94
|
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
86
95
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
87
96
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
97
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
88
98
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
89
99
|
hasAttribute(qualifiedName: string): boolean;
|
90
100
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
@@ -142,24 +152,24 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
142
152
|
normalize(): void;
|
143
153
|
removeChild<T_2 extends Node>(child: T_2): T_2;
|
144
154
|
replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
|
145
|
-
readonly
|
146
|
-
readonly
|
147
|
-
readonly
|
148
|
-
readonly
|
149
|
-
readonly
|
150
|
-
readonly
|
151
|
-
readonly
|
152
|
-
readonly
|
153
|
-
readonly
|
154
|
-
readonly
|
155
|
-
readonly
|
156
|
-
readonly
|
157
|
-
readonly
|
158
|
-
readonly
|
159
|
-
readonly
|
160
|
-
readonly
|
161
|
-
readonly
|
162
|
-
readonly
|
155
|
+
readonly ELEMENT_NODE: 1;
|
156
|
+
readonly ATTRIBUTE_NODE: 2;
|
157
|
+
readonly TEXT_NODE: 3;
|
158
|
+
readonly CDATA_SECTION_NODE: 4;
|
159
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
160
|
+
readonly ENTITY_NODE: 6;
|
161
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
162
|
+
readonly COMMENT_NODE: 8;
|
163
|
+
readonly DOCUMENT_NODE: 9;
|
164
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
165
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
166
|
+
readonly NOTATION_NODE: 12;
|
167
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
168
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
169
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
170
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
171
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
172
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
163
173
|
dispatchEvent(event: Event): boolean;
|
164
174
|
ariaAtomic: string;
|
165
175
|
ariaAutoComplete: string;
|
@@ -167,9 +177,9 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
167
177
|
ariaChecked: string;
|
168
178
|
ariaColCount: string;
|
169
179
|
ariaColIndex: string;
|
170
|
-
ariaColIndexText: string;
|
171
180
|
ariaColSpan: string;
|
172
181
|
ariaCurrent: string;
|
182
|
+
ariaDescription: string;
|
173
183
|
ariaDisabled: string;
|
174
184
|
ariaExpanded: string;
|
175
185
|
ariaHasPopup: string;
|
@@ -191,7 +201,6 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
191
201
|
ariaRoleDescription: string;
|
192
202
|
ariaRowCount: string;
|
193
203
|
ariaRowIndex: string;
|
194
|
-
ariaRowIndexText: string;
|
195
204
|
ariaRowSpan: string;
|
196
205
|
ariaSelected: string;
|
197
206
|
ariaSetSize: string;
|
@@ -216,17 +225,19 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
216
225
|
readonly lastElementChild: Element;
|
217
226
|
append(...nodes: (string | Node)[]): void;
|
218
227
|
prepend(...nodes: (string | Node)[]): void;
|
219
|
-
querySelector<
|
220
|
-
querySelector<
|
228
|
+
querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
|
229
|
+
querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
|
230
|
+
querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
|
231
|
+
querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
|
221
232
|
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
222
|
-
querySelectorAll<
|
223
|
-
querySelectorAll<
|
233
|
+
querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
|
234
|
+
querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
|
235
|
+
querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
|
236
|
+
querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
|
224
237
|
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
225
238
|
replaceChildren(...nodes: (string | Node)[]): void;
|
226
239
|
readonly assignedSlot: HTMLSlotElement;
|
227
|
-
|
228
|
-
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
229
|
-
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
240
|
+
readonly attributeStyleMap: StylePropertyMap;
|
230
241
|
readonly style: CSSStyleDeclaration;
|
231
242
|
contentEditable: string;
|
232
243
|
enterKeyHint: string;
|
@@ -239,6 +250,7 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
239
250
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
240
251
|
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
241
252
|
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
253
|
+
onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
242
254
|
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
243
255
|
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
244
256
|
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -247,7 +259,9 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
247
259
|
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
248
260
|
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
249
261
|
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
262
|
+
oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
250
263
|
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
264
|
+
oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
251
265
|
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
252
266
|
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
253
267
|
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
@@ -280,6 +294,7 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
280
294
|
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
281
295
|
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
282
296
|
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
297
|
+
onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
283
298
|
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
284
299
|
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
285
300
|
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -296,6 +311,7 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
296
311
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
297
312
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
298
313
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
314
|
+
onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
|
299
315
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
300
316
|
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
301
317
|
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -332,3 +348,14 @@ PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
332
348
|
};
|
333
349
|
} & TBase
|
334
350
|
```
|
351
|
+
|
352
|
+
## Parameters
|
353
|
+
|
354
|
+
| Parameter | Type | Description |
|
355
|
+
| --- | --- | --- |
|
356
|
+
| Base | TBase | |
|
357
|
+
|
358
|
+
**Returns:**
|
359
|
+
|
360
|
+
{ new (...args: any\[\]): { pendingCount: number; resolvedCount: number; hasPendingChildren: boolean; readonly progress: number; connectedCallback(): void; disconnectedCallback(): void; onPendingState({ detail }: [PendingStateEvent](./foundation-utils.pendingstateevent.md)<!-- -->): Promise<void>; readonly $fastController: import("@microsoft/fast-element").Controller; $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean \| void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; accessKey: string; readonly accessKeyLabel: string; autocapitalize: string; dir: string; draggable: boolean; hidden: boolean; inert: boolean; innerText: string; lang: string; readonly offsetHeight: number; readonly offsetLeft: number; readonly offsetParent: Element; readonly offsetTop: number; readonly offsetWidth: number; outerText: string; popover: string; spellcheck: boolean; title: string; translate: boolean; attachInternals(): ElementInternals; click(): void; hidePopover(): void; showPopover(): void; togglePopover(force?: boolean): boolean; addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\]) => any, options?: boolean \| AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions): void; removeEventListener<K\_1 extends keyof HTMLElementEventMap>(type: K\_1, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\_1\]) => any, options?: boolean \| EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| EventListenerOptions): void; readonly attributes: NamedNodeMap; readonly classList: DOMTokenList; className: string; readonly clientHeight: number; readonly clientLeft: number; readonly clientTop: number; readonly clientWidth: number; id: string; readonly localName: string; readonly namespaceURI: string; onfullscreenchange: (this: Element, ev: Event) => any; onfullscreenerror: (this: Element, ev: Event) => any; outerHTML: string; readonly ownerDocument: Document; readonly part: DOMTokenList; readonly prefix: string; readonly scrollHeight: number; scrollLeft: number; scrollTop: number; readonly scrollWidth: number; readonly shadowRoot: ShadowRoot; slot: string; readonly tagName: string; attachShadow(init: ShadowRootInit): ShadowRoot; checkVisibility(options?: CheckVisibilityOptions): boolean; closest<K\_2 extends keyof HTMLElementTagNameMap>(selector: K\_2): HTMLElementTagNameMap\[K\_2\]; closest<K\_3 extends keyof SVGElementTagNameMap>(selector: K\_3): SVGElementTagNameMap\[K\_3\]; closest<K\_4 extends keyof MathMLElementTagNameMap>(selector: K\_4): MathMLElementTagNameMap\[K\_4\]; closest<E extends Element = Element>(selectors: string): E; computedStyleMap(): StylePropertyMapReadOnly; getAttribute(qualifiedName: string): string; getAttributeNS(namespace: string, localName: string): string; getAttributeNames(): string\[\]; getAttributeNode(qualifiedName: string): Attr; getAttributeNodeNS(namespace: string, localName: string): Attr; getBoundingClientRect(): DOMRect; getClientRects(): DOMRectList; getElementsByClassName(classNames: string): HTMLCollectionOf<Element>; getElementsByTagName<K\_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K\_5): HTMLCollectionOf<HTMLElementTagNameMap\[K\_5\]>; getElementsByTagName<K\_6 extends keyof SVGElementTagNameMap>(qualifiedName: K\_6): HTMLCollectionOf<SVGElementTagNameMap\[K\_6\]>; getElementsByTagName<K\_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K\_7): HTMLCollectionOf<MathMLElementTagNameMap\[K\_7\]>; getElementsByTagName<K\_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K\_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap\[K\_8\]>; getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>; getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>; hasAttribute(qualifiedName: string): boolean; hasAttributeNS(namespace: string, localName: string): boolean; hasAttributes(): boolean; hasPointerCapture(pointerId: number): boolean; insertAdjacentElement(where: InsertPosition, element: Element): Element; insertAdjacentHTML(position: InsertPosition, text: string): void; insertAdjacentText(where: InsertPosition, data: string): void; matches(selectors: string): boolean; releasePointerCapture(pointerId: number): void; removeAttribute(qualifiedName: string): void; removeAttributeNS(namespace: string, localName: string): void; removeAttributeNode(attr: Attr): Attr; requestFullscreen(options?: FullscreenOptions): Promise<void>; requestPointerLock(): void; scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; scrollIntoView(arg?: boolean \| ScrollIntoViewOptions): void; scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; setAttribute(qualifiedName: string, value: string): void; setAttributeNS(namespace: string, qualifiedName: string, value: string): void; setAttributeNode(attr: Attr): Attr; setAttributeNodeNS(attr: Attr): Attr; setPointerCapture(pointerId: number): void; toggleAttribute(qualifiedName: string, force?: boolean): boolean; webkitMatchesSelector(selectors: string): boolean; readonly baseURI: string; readonly childNodes: NodeListOf<ChildNode>; readonly firstChild: ChildNode; readonly isConnected: boolean; readonly lastChild: ChildNode; readonly nextSibling: ChildNode; readonly nodeName: string; readonly nodeType: number; nodeValue: string; readonly parentElement: HTMLElement; readonly parentNode: ParentNode; readonly previousSibling: ChildNode; textContent: string; appendChild<T extends Node>(node: T): T; cloneNode(deep?: boolean): Node; compareDocumentPosition(other: Node): number; contains(other: Node): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore<T\_1 extends Node>(node: T\_1, child: Node): T\_1; isDefaultNamespace(namespace: string): boolean; isEqualNode(otherNode: Node): boolean; isSameNode(otherNode: Node): boolean; lookupNamespaceURI(prefix: string): string; lookupPrefix(namespace: string): string; normalize(): void; removeChild<T\_2 extends Node>(child: T\_2): T\_2; replaceChild<T\_3 extends Node>(node: Node, child: T\_3): T\_3; readonly ELEMENT\_NODE: 1; readonly ATTRIBUTE\_NODE: 2; readonly TEXT\_NODE: 3; readonly CDATA\_SECTION\_NODE: 4; readonly ENTITY\_REFERENCE\_NODE: 5; readonly ENTITY\_NODE: 6; readonly PROCESSING\_INSTRUCTION\_NODE: 7; readonly COMMENT\_NODE: 8; readonly DOCUMENT\_NODE: 9; readonly DOCUMENT\_TYPE\_NODE: 10; readonly DOCUMENT\_FRAGMENT\_NODE: 11; readonly NOTATION\_NODE: 12; readonly DOCUMENT\_POSITION\_DISCONNECTED: 1; readonly DOCUMENT\_POSITION\_PRECEDING: 2; readonly DOCUMENT\_POSITION\_FOLLOWING: 4; readonly DOCUMENT\_POSITION\_CONTAINS: 8; readonly DOCUMENT\_POSITION\_CONTAINED\_BY: 16; readonly DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC: 32; dispatchEvent(event: Event): boolean; ariaAtomic: string; ariaAutoComplete: string; ariaBusy: string; ariaChecked: string; ariaColCount: string; ariaColIndex: string; ariaColSpan: string; ariaCurrent: string; ariaDescription: string; ariaDisabled: string; ariaExpanded: string; ariaHasPopup: string; ariaHidden: string; ariaInvalid: string; ariaKeyShortcuts: string; ariaLabel: string; ariaLevel: string; ariaLive: string; ariaModal: string; ariaMultiLine: string; ariaMultiSelectable: string; ariaOrientation: string; ariaPlaceholder: string; ariaPosInSet: string; ariaPressed: string; ariaReadOnly: string; ariaRequired: string; ariaRoleDescription: string; ariaRowCount: string; ariaRowIndex: string; ariaRowSpan: string; ariaSelected: string; ariaSetSize: string; ariaSort: string; ariaValueMax: string; ariaValueMin: string; ariaValueNow: string; ariaValueText: string; role: string; animate(keyframes: Keyframe\[\] \| PropertyIndexedKeyframes, options?: number \| KeyframeAnimationOptions): Animation; getAnimations(options?: GetAnimationsOptions): Animation\[\]; after(...nodes: (string \| Node)\[\]): void; before(...nodes: (string \| Node)\[\]): void; remove(): void; replaceWith(...nodes: (string \| Node)\[\]): void; innerHTML: string; readonly nextElementSibling: Element; readonly previousElementSibling: Element; readonly childElementCount: number; readonly children: HTMLCollection; readonly firstElementChild: Element; readonly lastElementChild: Element; append(...nodes: (string \| Node)\[\]): void; prepend(...nodes: (string \| Node)\[\]): void; querySelector<K\_9 extends keyof HTMLElementTagNameMap>(selectors: K\_9): HTMLElementTagNameMap\[K\_9\]; querySelector<K\_10 extends keyof SVGElementTagNameMap>(selectors: K\_10): SVGElementTagNameMap\[K\_10\]; querySelector<K\_11 extends keyof MathMLElementTagNameMap>(selectors: K\_11): MathMLElementTagNameMap\[K\_11\]; querySelector<K\_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_12): HTMLElementDeprecatedTagNameMap\[K\_12\]; querySelector<E\_1 extends Element = Element>(selectors: string): E\_1; querySelectorAll<K\_13 extends keyof HTMLElementTagNameMap>(selectors: K\_13): NodeListOf<HTMLElementTagNameMap\[K\_13\]>; querySelectorAll<K\_14 extends keyof SVGElementTagNameMap>(selectors: K\_14): NodeListOf<SVGElementTagNameMap\[K\_14\]>; querySelectorAll<K\_15 extends keyof MathMLElementTagNameMap>(selectors: K\_15): NodeListOf<MathMLElementTagNameMap\[K\_15\]>; querySelectorAll<K\_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_16): NodeListOf<HTMLElementDeprecatedTagNameMap\[K\_16\]>; querySelectorAll<E\_2 extends Element = Element>(selectors: string): NodeListOf<E\_2>; replaceChildren(...nodes: (string \| Node)\[\]): void; readonly assignedSlot: HTMLSlotElement; readonly attributeStyleMap: StylePropertyMap; readonly style: CSSStyleDeclaration; contentEditable: string; enterKeyHint: string; inputMode: string; readonly isContentEditable: boolean; onabort: (this: GlobalEventHandlers, ev: UIEvent) => any; onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any; onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any; onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any; oncancel: (this: GlobalEventHandlers, ev: Event) => any; oncanplay: (this: GlobalEventHandlers, ev: Event) => any; oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any; onchange: (this: GlobalEventHandlers, ev: Event) => any; onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onclose: (this: GlobalEventHandlers, ev: Event) => any; oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any; oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; oncuechange: (this: GlobalEventHandlers, ev: Event) => any; oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any; ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any; ondurationchange: (this: GlobalEventHandlers, ev: Event) => any; onemptied: (this: GlobalEventHandlers, ev: Event) => any; onended: (this: GlobalEventHandlers, ev: Event) => any; onerror: OnErrorEventHandlerNonNull; onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any; onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any; ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; oninput: (this: GlobalEventHandlers, ev: Event) => any; oninvalid: (this: GlobalEventHandlers, ev: Event) => any; onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onload: (this: GlobalEventHandlers, ev: Event) => any; onloadeddata: (this: GlobalEventHandlers, ev: Event) => any; onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any; onloadstart: (this: GlobalEventHandlers, ev: Event) => any; onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any; onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; onpause: (this: GlobalEventHandlers, ev: Event) => any; onplay: (this: GlobalEventHandlers, ev: Event) => any; onplaying: (this: GlobalEventHandlers, ev: Event) => any; onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any; onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any; onratechange: (this: GlobalEventHandlers, ev: Event) => any; onreset: (this: GlobalEventHandlers, ev: Event) => any; onresize: (this: GlobalEventHandlers, ev: UIEvent) => any; onscroll: (this: GlobalEventHandlers, ev: Event) => any; onscrollend: (this: GlobalEventHandlers, ev: Event) => any; onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any; onseeked: (this: GlobalEventHandlers, ev: Event) => any; onseeking: (this: GlobalEventHandlers, ev: Event) => any; onselect: (this: GlobalEventHandlers, ev: Event) => any; onselectionchange: (this: GlobalEventHandlers, ev: Event) => any; onselectstart: (this: GlobalEventHandlers, ev: Event) => any; onslotchange: (this: GlobalEventHandlers, ev: Event) => any; onstalled: (this: GlobalEventHandlers, ev: Event) => any; onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any; onsuspend: (this: GlobalEventHandlers, ev: Event) => any; ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any; ontoggle: (this: GlobalEventHandlers, ev: Event) => any; ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any; onvolumechange: (this: GlobalEventHandlers, ev: Event) => any; onwaiting: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any; onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any; onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any; autofocus: boolean; readonly dataset: DOMStringMap; nonce?: string; tabIndex: number; blur(): void; focus(options?: FocusOptions): void; }; } & TBase
|
361
|
+
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [resolveAfter](./foundation-utils.resolveafter.md)
|
4
4
|
|
5
|
-
## resolveAfter
|
5
|
+
## resolveAfter() function
|
6
6
|
|
7
7
|
Resolve a promise after a timeout.
|
8
8
|
|
@@ -12,6 +12,17 @@ Resolve a promise after a timeout.
|
|
12
12
|
resolveAfter: <T = any>(ms: number, valueCreator: () => T) => Promise<T>
|
13
13
|
```
|
14
14
|
|
15
|
+
## Parameters
|
16
|
+
|
17
|
+
| Parameter | Type | Description |
|
18
|
+
| --- | --- | --- |
|
19
|
+
| ms | number | |
|
20
|
+
| valueCreator | () => T | |
|
21
|
+
|
22
|
+
**Returns:**
|
23
|
+
|
24
|
+
Promise<T>
|
25
|
+
|
15
26
|
## Example
|
16
27
|
|
17
28
|
|