@genesislcap/foundation-utils 14.65.2 → 14.66.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dts/error/errorMap.d.ts +97 -0
- package/dist/dts/error/errorMap.d.ts.map +1 -0
- package/dist/dts/error/index.d.ts +2 -0
- package/dist/dts/error/index.d.ts.map +1 -0
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/serializers/json/index.d.ts +2 -0
- package/dist/dts/serializers/json/index.d.ts.map +1 -1
- package/dist/dts/serializers/json/jsonReplacer.d.ts +9 -0
- package/dist/dts/serializers/json/jsonReplacer.d.ts.map +1 -0
- package/dist/dts/serializers/json/jsonReviver.d.ts +9 -0
- package/dist/dts/serializers/json/jsonReviver.d.ts.map +1 -0
- package/dist/dts/serializers/json/types.d.ts +26 -0
- package/dist/dts/serializers/json/types.d.ts.map +1 -0
- package/dist/dts/tsdoc-metadata.json +11 -0
- package/dist/esm/error/errorMap.js +101 -0
- package/dist/esm/error/index.js +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/serializers/json/index.js +2 -0
- package/dist/esm/serializers/json/jsonReplacer.js +26 -0
- package/dist/esm/serializers/json/jsonReviver.js +32 -0
- package/dist/esm/serializers/json/types.js +40 -0
- package/dist/foundation-utils.api.json +11993 -0
- package/dist/foundation-utils.d.ts +1599 -0
- package/docs/.gitattributes +2 -0
- package/docs/api/foundation-utils.createerrormap.md +13 -0
- package/docs/api/foundation-utils.defaulterrormap._constructor_.md +20 -0
- package/docs/api/foundation-utils.defaulterrormap.clear.md +17 -0
- package/docs/api/foundation-utils.defaulterrormap.delete.md +26 -0
- package/docs/api/foundation-utils.defaulterrormap.get.md +26 -0
- package/docs/api/foundation-utils.defaulterrormap.has.md +26 -0
- package/docs/api/foundation-utils.defaulterrormap.lasterror.md +13 -0
- package/docs/api/foundation-utils.defaulterrormap.md +38 -0
- package/docs/api/foundation-utils.defaulterrormap.messages.md +13 -0
- package/docs/api/foundation-utils.defaulterrormap.set.md +25 -0
- package/docs/api/foundation-utils.defaulterrormap.size.md +13 -0
- package/docs/api/foundation-utils.errordetailmap.md +12 -0
- package/docs/api/foundation-utils.errormap.lasterror.md +13 -0
- package/docs/api/foundation-utils.errormap.md +27 -0
- package/docs/api/foundation-utils.errormap.messages.md +13 -0
- package/docs/api/foundation-utils.errormap.set.md +25 -0
- package/docs/api/foundation-utils.errormaplogger.md +12 -0
- package/docs/api/foundation-utils.jsonreplacer.md +27 -0
- package/docs/api/foundation-utils.jsonreviver.md +27 -0
- package/docs/api/foundation-utils.md +7 -0
- package/docs/api-report.md +35 -0
- package/package.json +7 -3
|
@@ -0,0 +1,1599 @@
|
|
|
1
|
+
import { Binding } from '@microsoft/fast-element';
|
|
2
|
+
import { CaptureType } from '@microsoft/fast-element';
|
|
3
|
+
import { Consola } from 'consola';
|
|
4
|
+
import { ConsolaOptions } from 'consola';
|
|
5
|
+
import { Constructable } from '@microsoft/fast-element';
|
|
6
|
+
import { Controller } from '@microsoft/fast-element';
|
|
7
|
+
import { CSSDesignToken } from '@microsoft/fast-foundation';
|
|
8
|
+
import { DesignSystem } from '@microsoft/fast-foundation';
|
|
9
|
+
import { ElementStyles } from '@microsoft/fast-element';
|
|
10
|
+
import { FASTElement } from '@microsoft/fast-element';
|
|
11
|
+
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
12
|
+
import { LogLevel } from 'consola';
|
|
13
|
+
import { SyntheticViewTemplate } from '@microsoft/fast-element';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* A design token that represents the active color scheme (light or dark).
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export declare const activeColorScheme: CSSDesignToken<string>;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).
|
|
23
|
+
* Example: wss://localhost:9064
|
|
24
|
+
* @remarks Required.
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export declare let API_HOST: string;
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export declare type ConstructableLifecycleHandler = Constructable<FASTElement & HTMLElement>;
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* A mixin that provides functionality for raising `pending-state` events.
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export declare type ConstructablePendingState = Constructable<FASTElement & HTMLElement>;
|
|
44
|
+
|
|
45
|
+
declare type Container = FoundationLayoutContainer | LayoutCacheContainer | DOMContainer;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Represents the possible types of value conversion for data synchronization.
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export declare type ConversionType = 'string' | 'number' | 'time' | 'boolean';
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* A factory to create the error map.
|
|
55
|
+
* @param logger - A logger error method reference.
|
|
56
|
+
* @returns A ErrorMap instance.
|
|
57
|
+
*
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export declare const createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>;
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Creates a logger with the given name and options.
|
|
64
|
+
* @param name - The name to give the logger.
|
|
65
|
+
* @param options - The options to use when creating the logger.
|
|
66
|
+
* @returns The resulting logger.
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare function createLogger(name: string, options?: LoggerOptions): Logger;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Creates a new event observer instance.
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare const createObserver: <EventType>() => Observer<EventType>;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Represents a database with basic CRUD operations.
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare interface Database<T extends DatabaseRecord> {
|
|
82
|
+
isWorking: boolean;
|
|
83
|
+
create(newValue: Omit<T, 'id'>): Promise<DatabaseAccessResult.Create<T>>;
|
|
84
|
+
read(id: string): Promise<DatabaseAccessResult.Read<T>>;
|
|
85
|
+
update(id: string, newValue: Omit<Partial<T>, 'id'>): Promise<DatabaseAccessResult.Update<T>>;
|
|
86
|
+
delete(id: string): Promise<DatabaseAccessResult.Delete>;
|
|
87
|
+
visit(visitor: (record: T) => void): Promise<void>;
|
|
88
|
+
onBeforeUpdate(listener: Listener<DatabaseEvent.BeforeUpdate<T>>): () => void;
|
|
89
|
+
onAfterUpdate(listener: Listener<DatabaseEvent.AfterUpdate<T>>): () => void;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Namespace for database access result types.
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare namespace DatabaseAccessResult {
|
|
97
|
+
export interface Access<T> {
|
|
98
|
+
value: T;
|
|
99
|
+
}
|
|
100
|
+
export interface Create<T> extends Access<T> {
|
|
101
|
+
}
|
|
102
|
+
export interface Read<T> extends Access<T> {
|
|
103
|
+
}
|
|
104
|
+
export interface Update<T> extends Access<T> {
|
|
105
|
+
}
|
|
106
|
+
export interface Delete {
|
|
107
|
+
id: string;
|
|
108
|
+
success: boolean;
|
|
109
|
+
}
|
|
110
|
+
{};
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Namespace for database events.
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export declare namespace DatabaseEvent {
|
|
118
|
+
export interface Update<T> {
|
|
119
|
+
value: T;
|
|
120
|
+
}
|
|
121
|
+
export interface BeforeUpdate<T> extends Update<T> {
|
|
122
|
+
newValue: T;
|
|
123
|
+
}
|
|
124
|
+
export interface AfterUpdate<T> extends Update<T> {
|
|
125
|
+
}
|
|
126
|
+
{};
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Represents a database record.
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export declare interface DatabaseRecord {
|
|
134
|
+
id: string;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
|
|
139
|
+
* @remarks Optional.
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
export declare let DEFAULT_ORGANISATION: string;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
|
|
146
|
+
* @remarks Optional.
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
export declare let DEFAULT_PASSWORD: string;
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
|
|
153
|
+
* @remarks Optional.
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export declare let DEFAULT_USER: string;
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
export declare class DefaultErrorMap<TErrorDetailMap extends ErrorDetailMap> implements ErrorMap<TErrorDetailMap> {
|
|
162
|
+
private logger;
|
|
163
|
+
private map;
|
|
164
|
+
/** {@inheritDoc ErrorMap.lastError} */
|
|
165
|
+
lastError: Error;
|
|
166
|
+
/**
|
|
167
|
+
* @param logger - A logger error method reference.
|
|
168
|
+
*/
|
|
169
|
+
constructor(logger: ErrorMapLogger);
|
|
170
|
+
/** {@inheritDoc ErrorMap.set} */
|
|
171
|
+
set(key: keyof TErrorDetailMap, error: Error): void;
|
|
172
|
+
/**
|
|
173
|
+
* Get an error by key.
|
|
174
|
+
* @param key - The key.
|
|
175
|
+
* @returns The error if it exists, otherwise undefined.
|
|
176
|
+
*
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
get(key: keyof TErrorDetailMap): Error | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Has an error for key.
|
|
182
|
+
* @param key - The key.
|
|
183
|
+
* @returns True if it exists, otherwise false.
|
|
184
|
+
*
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
has(key: keyof TErrorDetailMap): boolean;
|
|
188
|
+
/**
|
|
189
|
+
* Delete an error.
|
|
190
|
+
* @param key - The key.
|
|
191
|
+
* @returns True if successful, otherwise false.
|
|
192
|
+
*
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
delete(key: keyof TErrorDetailMap): boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Clear errors.
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
clear(): void;
|
|
201
|
+
/**
|
|
202
|
+
* The size of the error map.
|
|
203
|
+
* @returns number
|
|
204
|
+
*
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
get size(): number;
|
|
208
|
+
/** {@inheritDoc ErrorMap.messages} */
|
|
209
|
+
get messages(): string;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* A map that associates specific HTML element tags with their corresponding default event names.
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
export declare const defaultEventMap: Map<string, EventName>;
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* The default logger options.
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
export declare const defaultLoggerOptions: LoggerOptions;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* The default `ServerRowDTOMapper`.
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export declare class DefaultServerRowDTOMapper implements ServerRowDTOMapper {
|
|
229
|
+
/**
|
|
230
|
+
* Converts a server row DTO to an entity.
|
|
231
|
+
* @param dto - The DTO to convert.
|
|
232
|
+
* @returns The resulting entity.
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
fromDTO: (dto: ServerRowDTO) => ServerRowEntity;
|
|
236
|
+
/**
|
|
237
|
+
* Converts a server row entity to a DTO.
|
|
238
|
+
* @param entity - The entity to convert.
|
|
239
|
+
* @returns The resulting DTO.
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
toDTO: (entity: ServerRowEntity) => ServerRowDTO;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
export declare interface DesignSystemModule {
|
|
249
|
+
provideDesignSystem(element?: HTMLElement, prefix?: string): DesignSystem | Pick<DesignSystem, 'register'>;
|
|
250
|
+
[key: string]: any;
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
export declare type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Signifies the element is placed on the DOM, not inside any dynamic layout components
|
|
260
|
+
* @internal
|
|
261
|
+
*/
|
|
262
|
+
export declare type DOMContainer = {
|
|
263
|
+
_key: 'dom';
|
|
264
|
+
};
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
export declare interface DTOMapper<TDTO, TEntity> {
|
|
270
|
+
fromArgs?: (...args: any[]) => TEntity;
|
|
271
|
+
fromDTO: (dto: TDTO) => TEntity;
|
|
272
|
+
toDTO: (entity: Partial<TEntity>) => TDTO;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export declare type ErrorDetailMap = Record<string, unknown>;
|
|
279
|
+
|
|
280
|
+
/**
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export declare interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size'> {
|
|
284
|
+
/**
|
|
285
|
+
* Error map as messages.
|
|
286
|
+
* @returns string
|
|
287
|
+
*
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
readonly messages: string;
|
|
291
|
+
/**
|
|
292
|
+
* Set an error by key.
|
|
293
|
+
* @param key - The key.
|
|
294
|
+
* @param error - The error.
|
|
295
|
+
*
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
set(key: keyof TErrorDetailMap, error: Error): void;
|
|
299
|
+
/**
|
|
300
|
+
* The last set error if any.
|
|
301
|
+
* @returns Error
|
|
302
|
+
*
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
readonly lastError: Error;
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
export declare type ErrorMapLogger = (...args: any[]) => void;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Represents the possible event names for data synchronization.
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
export declare type EventName = 'input' | 'change' | 'default';
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* An enum of possible font styles.
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
export declare enum FontStyle {
|
|
324
|
+
Italic = "italic",
|
|
325
|
+
Normal = "normal"
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* An enum of possible font weights.
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
export declare enum FontWeight {
|
|
333
|
+
Thin = 100,
|
|
334
|
+
Light = 300,
|
|
335
|
+
Regular = 400,
|
|
336
|
+
Medium = 500,
|
|
337
|
+
Bold = 700,
|
|
338
|
+
Black = 900
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* The path to a JSON config file for the HTTP mode.
|
|
343
|
+
* @remarks Optional.
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
export declare let FORCE_HTTP: string;
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
* Formats [DATE] UNIX Timestamps (without time) to readable strings
|
|
350
|
+
* @public
|
|
351
|
+
*/
|
|
352
|
+
export declare function formatDateTimestamp(timestamp: number): string;
|
|
353
|
+
|
|
354
|
+
/**
|
|
355
|
+
* Formats [DATETIME] UNIX Timestamps (with time) to readable strings
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
358
|
+
export declare function formatDateTimeTimestamp(timestamp: number): string;
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* Formats [DATE|DATETIME] Unix Timestamps to readable strings
|
|
362
|
+
* @public
|
|
363
|
+
* @param timestamp - The UNIX Timestamp.
|
|
364
|
+
* @param withTime - The flag to determine if formatted value should contain 'time' info.
|
|
365
|
+
*/
|
|
366
|
+
export declare function formatTimestamp(timestamp: number, withTime: boolean): string;
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Minimum interface to interact with FoundationLayout
|
|
370
|
+
* without importing it as a dependency of `@genesislcap/foundation-utils`
|
|
371
|
+
* @internal
|
|
372
|
+
*/
|
|
373
|
+
export declare type FoundationLayoutContainer = {
|
|
374
|
+
dragging: boolean;
|
|
375
|
+
hasFirstLoaded: boolean;
|
|
376
|
+
_key: 'foundation-layout';
|
|
377
|
+
};
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
* Generates a CSS mixin for the specified font family, style, and weight.
|
|
381
|
+
* @param family - The font family.
|
|
382
|
+
* @param style - Optional. The font style. Defaults to FontStyle.Normal.
|
|
383
|
+
* @param weight - Optional. The font weight. Defaults to FontWeight.Regular.
|
|
384
|
+
* @returns The generated CSS mixin.
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
export declare const getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string;
|
|
388
|
+
|
|
389
|
+
/**
|
|
390
|
+
* Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).
|
|
391
|
+
* @remarks Optional.
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export declare let HTTP_CONFIG: string;
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* Returns a boolean value indicating whether the current window is inside an iframe.
|
|
398
|
+
* @returns true if the window is inside an iframe, false otherwise.
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
export declare const inIFrame: () => boolean;
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* An in memory database of specific DatabaseRecord types.
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
export declare class InMemoryDatabase<T extends DatabaseRecord> implements Database<T> {
|
|
408
|
+
private uuid;
|
|
409
|
+
isWorking: boolean;
|
|
410
|
+
private records;
|
|
411
|
+
private beforeUpdateListeners;
|
|
412
|
+
private afterUpdateListeners;
|
|
413
|
+
constructor(uuid: UUID);
|
|
414
|
+
create(newValue: Omit<T, 'id'>): Promise<DatabaseAccessResult.Create<T>>;
|
|
415
|
+
read(id: string): Promise<DatabaseAccessResult.Read<T>>;
|
|
416
|
+
update(id: string, newValue: Omit<Partial<T>, 'id'>): Promise<DatabaseAccessResult.Update<T>>;
|
|
417
|
+
delete(id: string): Promise<DatabaseAccessResult.Delete>;
|
|
418
|
+
visit(visitor: (record: T) => void): Promise<void>;
|
|
419
|
+
onBeforeUpdate(listener: Listener<DatabaseEvent.BeforeUpdate<T>>): () => void;
|
|
420
|
+
onAfterUpdate(listener: Listener<DatabaseEvent.AfterUpdate<T>>): () => void;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID.
|
|
425
|
+
* Returns a function that can be called to remove the rule from the document.
|
|
426
|
+
* @public
|
|
427
|
+
* @param cssRule - The CSS rule to insert.
|
|
428
|
+
* @param styleElementId - The ID of the style element to use or create.
|
|
429
|
+
* @returns A function that removes the rule from the document.
|
|
430
|
+
*/
|
|
431
|
+
export declare const insertDocumentCSSRule: (cssRule: string, styleElementId: string) => (() => void);
|
|
432
|
+
|
|
433
|
+
/**
|
|
434
|
+
* Inserts a CSS link into the document if it doesn't already exist.
|
|
435
|
+
* @public
|
|
436
|
+
* @param href - The URL of the CSS file to insert.
|
|
437
|
+
*/
|
|
438
|
+
export declare const insertDocumentLink: (href: string) => void;
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* Returns a boolean value indicating whether the user is running the Symphony desktop app.
|
|
442
|
+
* @returns true if the user is running the Symphony desktop app, false otherwise.
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
export declare const inSymphonyDesktop: () => boolean;
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* Determines if the current environment is a development environment.
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
export declare const isDev: () => boolean;
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* JSON replacer function.
|
|
455
|
+
* @param key - The object key.
|
|
456
|
+
* @param value - The key value.
|
|
457
|
+
* @returns The resulting value.
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
export declare function JSONReplacer(key: string, value: any): any;
|
|
461
|
+
|
|
462
|
+
/**
|
|
463
|
+
* JSON reviver function.
|
|
464
|
+
* @param key - The object key.
|
|
465
|
+
* @param value - The key value.
|
|
466
|
+
* @returns The resulting value.
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
export declare function JSONReviver(key: string, value: any): any;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* An interface representing a JSON serializer.
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
export declare interface JSONSerializer {
|
|
476
|
+
/**
|
|
477
|
+
* Serializes an object to a JSON string.
|
|
478
|
+
* @param object - The object to serialize.
|
|
479
|
+
* @returns The serialized JSON string.
|
|
480
|
+
*/
|
|
481
|
+
serialize(object: any): string;
|
|
482
|
+
/**
|
|
483
|
+
* Deserializes a response object from a HTTP request to a JavaScript object.
|
|
484
|
+
* @param response - The HTTP response object.
|
|
485
|
+
* @returns A promise that resolves to the deserialized JavaScript object.
|
|
486
|
+
*/
|
|
487
|
+
deserialize<T = any>(response: Response): Promise<T>;
|
|
488
|
+
/**
|
|
489
|
+
* Deserializes a message event object to a JavaScript object.
|
|
490
|
+
* @param event - The message event object.
|
|
491
|
+
* @returns The deserialized JavaScript object.
|
|
492
|
+
*/
|
|
493
|
+
deserialize<T = any>(event: MessageEvent): T;
|
|
494
|
+
/**
|
|
495
|
+
* Deserializes a JSON string to a JavaScript object.
|
|
496
|
+
* @param text - The JSON string to deserialize.
|
|
497
|
+
* @returns The deserialized JavaScript object.
|
|
498
|
+
*/
|
|
499
|
+
deserialize<T = any>(text: string): T;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* A DI token for the JSON serializer.
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
export declare const JSONSerializer: InterfaceSymbol<JSONSerializer>;
|
|
507
|
+
|
|
508
|
+
/**
|
|
509
|
+
* Signifies the internal document fragment that stores the master copy
|
|
510
|
+
* of the layout item, not part of the DOM.
|
|
511
|
+
* @internal
|
|
512
|
+
*/
|
|
513
|
+
export declare type LayoutCacheContainer = {
|
|
514
|
+
_key: 'foundation-layout-cache';
|
|
515
|
+
};
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Stored on the layout's internal cache to signify that the document is not part of the DOM
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
export declare const layoutCacheDocument: unique symbol;
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* @beta
|
|
525
|
+
* Mixin class to expose `shouldRunConnect` and `shouldRunDisconnect`
|
|
526
|
+
*
|
|
527
|
+
* @remarks These can be used to control what lifecycle functionality is ran when the elements
|
|
528
|
+
* are part of a custom layout. The class itself handles all events
|
|
529
|
+
* @privateRemarks
|
|
530
|
+
* #_ syntax is used for a javascript private method/variable
|
|
531
|
+
* we can't use private/protected from typescript in an anonymous class like this
|
|
532
|
+
*/
|
|
533
|
+
export declare const LifecycleMixin: <T extends ConstructableLifecycleHandler>(Base: T) => {
|
|
534
|
+
new (...args: any[]): {
|
|
535
|
+
/** @internal **/
|
|
536
|
+
"__#1@#_container": Container;
|
|
537
|
+
/**
|
|
538
|
+
* @privateRemarks
|
|
539
|
+
* Rather than using the basic implementation of cloning we run a copy constructor (deepClone)
|
|
540
|
+
* and then manually clone the children too so they can intercept with an overriden cloneNode
|
|
541
|
+
* if they want to
|
|
542
|
+
*/
|
|
543
|
+
cloneNode(deep?: boolean): Node;
|
|
544
|
+
/**
|
|
545
|
+
* @privateRemarks
|
|
546
|
+
* Basic implementation of a copy constructor which creates a new element of the same class
|
|
547
|
+
* and copies all attributes over.
|
|
548
|
+
* None-trivial elements will likely want to override this function, call it using super.deepClone(),
|
|
549
|
+
* and then perform extra setup such as copying properties, setting up event listeners
|
|
550
|
+
*/
|
|
551
|
+
deepClone(): Node;
|
|
552
|
+
/**
|
|
553
|
+
* @beta
|
|
554
|
+
* @returns - boolean controlling whether to run all disconnectedCallback lifecycle functionality
|
|
555
|
+
*/
|
|
556
|
+
readonly shouldRunDisconnect: boolean;
|
|
557
|
+
/**
|
|
558
|
+
* @beta
|
|
559
|
+
* @returns - boolean controlling whether to run all connectedCallback lifecycle functionality
|
|
560
|
+
* @privateRemarks
|
|
561
|
+
* For now its just the same logic as shouldRunDisconnect
|
|
562
|
+
*/
|
|
563
|
+
readonly shouldRunConnect: boolean;
|
|
564
|
+
/**
|
|
565
|
+
* @internal
|
|
566
|
+
* Recursive function to try and find containing layout object
|
|
567
|
+
*
|
|
568
|
+
* @returns the layout object casted to the {@link @genesislcap/foundation-utils#FoundationLayoutContainer} interface if we are in a
|
|
569
|
+
* layout object, {@link @genesislcap/foundation-utils#LayoutCacheContainer} if the element is in the layout cache, else {@link @genesislcap/foundation-utils#DOMContainer}.
|
|
570
|
+
*/
|
|
571
|
+
"__#1@#_tryFindContainingLayout"(e: Element): Container;
|
|
572
|
+
connectedCallback(): void;
|
|
573
|
+
readonly $fastController: Controller;
|
|
574
|
+
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
575
|
+
disconnectedCallback(): void;
|
|
576
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
577
|
+
accessKey: string;
|
|
578
|
+
readonly accessKeyLabel: string;
|
|
579
|
+
autocapitalize: string;
|
|
580
|
+
dir: string;
|
|
581
|
+
draggable: boolean;
|
|
582
|
+
hidden: boolean;
|
|
583
|
+
inert: boolean;
|
|
584
|
+
innerText: string;
|
|
585
|
+
lang: string;
|
|
586
|
+
readonly offsetHeight: number;
|
|
587
|
+
readonly offsetLeft: number;
|
|
588
|
+
readonly offsetParent: Element;
|
|
589
|
+
readonly offsetTop: number;
|
|
590
|
+
readonly offsetWidth: number;
|
|
591
|
+
outerText: string;
|
|
592
|
+
spellcheck: boolean;
|
|
593
|
+
title: string;
|
|
594
|
+
translate: boolean;
|
|
595
|
+
attachInternals(): ElementInternals;
|
|
596
|
+
click(): void;
|
|
597
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
598
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
599
|
+
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
600
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
601
|
+
readonly attributes: NamedNodeMap;
|
|
602
|
+
readonly classList: DOMTokenList;
|
|
603
|
+
className: string;
|
|
604
|
+
readonly clientHeight: number;
|
|
605
|
+
readonly clientLeft: number;
|
|
606
|
+
readonly clientTop: number;
|
|
607
|
+
readonly clientWidth: number;
|
|
608
|
+
id: string;
|
|
609
|
+
readonly localName: string;
|
|
610
|
+
readonly namespaceURI: string;
|
|
611
|
+
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
612
|
+
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
613
|
+
outerHTML: string;
|
|
614
|
+
readonly ownerDocument: Document;
|
|
615
|
+
readonly part: DOMTokenList;
|
|
616
|
+
readonly prefix: string;
|
|
617
|
+
readonly scrollHeight: number;
|
|
618
|
+
scrollLeft: number;
|
|
619
|
+
scrollTop: number;
|
|
620
|
+
readonly scrollWidth: number;
|
|
621
|
+
readonly shadowRoot: ShadowRoot;
|
|
622
|
+
slot: string;
|
|
623
|
+
readonly tagName: string;
|
|
624
|
+
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
625
|
+
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
|
626
|
+
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
|
627
|
+
closest<E extends Element = Element>(selectors: string): E;
|
|
628
|
+
getAttribute(qualifiedName: string): string;
|
|
629
|
+
getAttributeNS(namespace: string, localName: string): string;
|
|
630
|
+
getAttributeNames(): string[];
|
|
631
|
+
getAttributeNode(qualifiedName: string): Attr;
|
|
632
|
+
getAttributeNodeNS(namespace: string, localName: string): Attr;
|
|
633
|
+
getBoundingClientRect(): DOMRect;
|
|
634
|
+
getClientRects(): DOMRectList;
|
|
635
|
+
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
|
636
|
+
getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
|
|
637
|
+
getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
|
|
638
|
+
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
|
639
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
640
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
641
|
+
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
642
|
+
hasAttribute(qualifiedName: string): boolean;
|
|
643
|
+
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
644
|
+
hasAttributes(): boolean;
|
|
645
|
+
hasPointerCapture(pointerId: number): boolean;
|
|
646
|
+
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
647
|
+
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
648
|
+
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
649
|
+
matches(selectors: string): boolean;
|
|
650
|
+
releasePointerCapture(pointerId: number): void;
|
|
651
|
+
removeAttribute(qualifiedName: string): void;
|
|
652
|
+
removeAttributeNS(namespace: string, localName: string): void;
|
|
653
|
+
removeAttributeNode(attr: Attr): Attr;
|
|
654
|
+
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
655
|
+
requestPointerLock(): void;
|
|
656
|
+
scroll(options?: ScrollToOptions): void;
|
|
657
|
+
scroll(x: number, y: number): void;
|
|
658
|
+
scrollBy(options?: ScrollToOptions): void;
|
|
659
|
+
scrollBy(x: number, y: number): void;
|
|
660
|
+
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
661
|
+
scrollTo(options?: ScrollToOptions): void;
|
|
662
|
+
scrollTo(x: number, y: number): void;
|
|
663
|
+
setAttribute(qualifiedName: string, value: string): void;
|
|
664
|
+
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
665
|
+
setAttributeNode(attr: Attr): Attr;
|
|
666
|
+
setAttributeNodeNS(attr: Attr): Attr;
|
|
667
|
+
setPointerCapture(pointerId: number): void;
|
|
668
|
+
toggleAttribute(qualifiedName: string, force?: boolean): boolean;
|
|
669
|
+
webkitMatchesSelector(selectors: string): boolean;
|
|
670
|
+
readonly baseURI: string;
|
|
671
|
+
readonly childNodes: NodeListOf<ChildNode>;
|
|
672
|
+
readonly firstChild: ChildNode;
|
|
673
|
+
readonly isConnected: boolean;
|
|
674
|
+
readonly lastChild: ChildNode;
|
|
675
|
+
readonly nextSibling: ChildNode;
|
|
676
|
+
readonly nodeName: string;
|
|
677
|
+
readonly nodeType: number;
|
|
678
|
+
nodeValue: string;
|
|
679
|
+
readonly parentElement: HTMLElement;
|
|
680
|
+
readonly parentNode: ParentNode;
|
|
681
|
+
readonly previousSibling: ChildNode;
|
|
682
|
+
textContent: string;
|
|
683
|
+
appendChild<T_1 extends Node>(node: T_1): T_1;
|
|
684
|
+
compareDocumentPosition(other: Node): number;
|
|
685
|
+
contains(other: Node): boolean;
|
|
686
|
+
getRootNode(options?: GetRootNodeOptions): Node;
|
|
687
|
+
hasChildNodes(): boolean;
|
|
688
|
+
insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
|
|
689
|
+
isDefaultNamespace(namespace: string): boolean;
|
|
690
|
+
isEqualNode(otherNode: Node): boolean;
|
|
691
|
+
isSameNode(otherNode: Node): boolean;
|
|
692
|
+
lookupNamespaceURI(prefix: string): string;
|
|
693
|
+
lookupPrefix(namespace: string): string;
|
|
694
|
+
normalize(): void;
|
|
695
|
+
removeChild<T_3 extends Node>(child: T_3): T_3;
|
|
696
|
+
replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
|
|
697
|
+
readonly ATTRIBUTE_NODE: number;
|
|
698
|
+
readonly CDATA_SECTION_NODE: number;
|
|
699
|
+
readonly COMMENT_NODE: number;
|
|
700
|
+
readonly DOCUMENT_FRAGMENT_NODE: number;
|
|
701
|
+
readonly DOCUMENT_NODE: number;
|
|
702
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: number;
|
|
703
|
+
readonly DOCUMENT_POSITION_CONTAINS: number;
|
|
704
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: number;
|
|
705
|
+
readonly DOCUMENT_POSITION_FOLLOWING: number;
|
|
706
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
|
|
707
|
+
readonly DOCUMENT_POSITION_PRECEDING: number;
|
|
708
|
+
readonly DOCUMENT_TYPE_NODE: number;
|
|
709
|
+
readonly ELEMENT_NODE: number;
|
|
710
|
+
readonly ENTITY_NODE: number;
|
|
711
|
+
readonly ENTITY_REFERENCE_NODE: number;
|
|
712
|
+
readonly NOTATION_NODE: number;
|
|
713
|
+
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
714
|
+
readonly TEXT_NODE: number;
|
|
715
|
+
dispatchEvent(event: Event): boolean;
|
|
716
|
+
ariaAtomic: string;
|
|
717
|
+
ariaAutoComplete: string;
|
|
718
|
+
ariaBusy: string;
|
|
719
|
+
ariaChecked: string;
|
|
720
|
+
ariaColCount: string;
|
|
721
|
+
ariaColIndex: string;
|
|
722
|
+
ariaColIndexText: string;
|
|
723
|
+
ariaColSpan: string;
|
|
724
|
+
ariaCurrent: string;
|
|
725
|
+
ariaDisabled: string;
|
|
726
|
+
ariaExpanded: string;
|
|
727
|
+
ariaHasPopup: string;
|
|
728
|
+
ariaHidden: string;
|
|
729
|
+
ariaInvalid: string;
|
|
730
|
+
ariaKeyShortcuts: string;
|
|
731
|
+
ariaLabel: string;
|
|
732
|
+
ariaLevel: string;
|
|
733
|
+
ariaLive: string;
|
|
734
|
+
ariaModal: string;
|
|
735
|
+
ariaMultiLine: string;
|
|
736
|
+
ariaMultiSelectable: string;
|
|
737
|
+
ariaOrientation: string;
|
|
738
|
+
ariaPlaceholder: string;
|
|
739
|
+
ariaPosInSet: string;
|
|
740
|
+
ariaPressed: string;
|
|
741
|
+
ariaReadOnly: string;
|
|
742
|
+
ariaRequired: string;
|
|
743
|
+
ariaRoleDescription: string;
|
|
744
|
+
ariaRowCount: string;
|
|
745
|
+
ariaRowIndex: string;
|
|
746
|
+
ariaRowIndexText: string;
|
|
747
|
+
ariaRowSpan: string;
|
|
748
|
+
ariaSelected: string;
|
|
749
|
+
ariaSetSize: string;
|
|
750
|
+
ariaSort: string;
|
|
751
|
+
ariaValueMax: string;
|
|
752
|
+
ariaValueMin: string;
|
|
753
|
+
ariaValueNow: string;
|
|
754
|
+
ariaValueText: string;
|
|
755
|
+
role: string;
|
|
756
|
+
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation;
|
|
757
|
+
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
758
|
+
after(...nodes: (string | Node)[]): void;
|
|
759
|
+
before(...nodes: (string | Node)[]): void;
|
|
760
|
+
remove(): void;
|
|
761
|
+
replaceWith(...nodes: (string | Node)[]): void;
|
|
762
|
+
innerHTML: string;
|
|
763
|
+
readonly nextElementSibling: Element;
|
|
764
|
+
readonly previousElementSibling: Element;
|
|
765
|
+
readonly childElementCount: number;
|
|
766
|
+
readonly children: HTMLCollection;
|
|
767
|
+
readonly firstElementChild: Element;
|
|
768
|
+
readonly lastElementChild: Element;
|
|
769
|
+
append(...nodes: (string | Node)[]): void;
|
|
770
|
+
prepend(...nodes: (string | Node)[]): void;
|
|
771
|
+
querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
|
|
772
|
+
querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
|
|
773
|
+
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
|
774
|
+
querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
|
|
775
|
+
querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
|
|
776
|
+
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
|
777
|
+
replaceChildren(...nodes: (string | Node)[]): void;
|
|
778
|
+
readonly assignedSlot: HTMLSlotElement;
|
|
779
|
+
oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
780
|
+
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
781
|
+
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
782
|
+
readonly style: CSSStyleDeclaration;
|
|
783
|
+
contentEditable: string;
|
|
784
|
+
enterKeyHint: string;
|
|
785
|
+
inputMode: string;
|
|
786
|
+
readonly isContentEditable: boolean;
|
|
787
|
+
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
788
|
+
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
789
|
+
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
790
|
+
onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
791
|
+
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
792
|
+
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
793
|
+
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
|
794
|
+
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
795
|
+
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
|
796
|
+
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
797
|
+
oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
|
|
798
|
+
onchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
799
|
+
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
800
|
+
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
|
801
|
+
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
802
|
+
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
803
|
+
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
804
|
+
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
805
|
+
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
806
|
+
ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
807
|
+
ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
808
|
+
ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
809
|
+
ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
810
|
+
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
811
|
+
ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
812
|
+
onemptied: (this: GlobalEventHandlers, ev: Event) => any;
|
|
813
|
+
onended: (this: GlobalEventHandlers, ev: Event) => any;
|
|
814
|
+
onerror: OnErrorEventHandlerNonNull;
|
|
815
|
+
onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
816
|
+
onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
|
|
817
|
+
ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
818
|
+
oninput: (this: GlobalEventHandlers, ev: Event) => any;
|
|
819
|
+
oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
|
|
820
|
+
onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
821
|
+
onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
822
|
+
onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
823
|
+
onload: (this: GlobalEventHandlers, ev: Event) => any;
|
|
824
|
+
onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
825
|
+
onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
826
|
+
onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
827
|
+
onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
828
|
+
onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
829
|
+
onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
830
|
+
onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
831
|
+
onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
832
|
+
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
833
|
+
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
834
|
+
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
835
|
+
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
|
836
|
+
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
837
|
+
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
|
838
|
+
onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
839
|
+
onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
840
|
+
onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
841
|
+
onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
842
|
+
onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
843
|
+
onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
844
|
+
onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
845
|
+
onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
846
|
+
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
847
|
+
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
848
|
+
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
849
|
+
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
850
|
+
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
851
|
+
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
852
|
+
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
|
853
|
+
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
|
854
|
+
onselect: (this: GlobalEventHandlers, ev: Event) => any;
|
|
855
|
+
onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
856
|
+
onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
857
|
+
onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
858
|
+
onstalled: (this: GlobalEventHandlers, ev: Event) => any;
|
|
859
|
+
onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
|
|
860
|
+
onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
861
|
+
ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
|
|
862
|
+
ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
|
863
|
+
ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
864
|
+
ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
865
|
+
ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
866
|
+
ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
867
|
+
ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
868
|
+
ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
869
|
+
ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
870
|
+
ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
871
|
+
onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
872
|
+
onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
|
|
873
|
+
onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
874
|
+
onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
|
|
875
|
+
onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
876
|
+
onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
877
|
+
onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
|
|
878
|
+
autofocus: boolean;
|
|
879
|
+
readonly dataset: DOMStringMap;
|
|
880
|
+
nonce?: string;
|
|
881
|
+
tabIndex: number;
|
|
882
|
+
blur(): void;
|
|
883
|
+
focus(options?: FocusOptions): void;
|
|
884
|
+
};
|
|
885
|
+
} & T;
|
|
886
|
+
|
|
887
|
+
/**
|
|
888
|
+
* Creates an observer that facilitates the subscription and publication of events.
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
export declare type Listener<EventType> = (ev: EventType) => void;
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* Loads font faces by inserting a style element with the specified font face rules into the document.
|
|
895
|
+
* @param fontFaceRules - The CSS rules for the font faces.
|
|
896
|
+
* @param styleElementId - The ID of the style element to insert into the document.
|
|
897
|
+
* @public
|
|
898
|
+
*/
|
|
899
|
+
export declare const loadFontFaces: (fontFaceRules: string, styleElementId: string) => void;
|
|
900
|
+
|
|
901
|
+
/**
|
|
902
|
+
* A logger that extends the `Consola` logger.
|
|
903
|
+
*
|
|
904
|
+
* @remarks
|
|
905
|
+
* This logger is part of the package's API but may still be subject to changes and improvements.
|
|
906
|
+
*
|
|
907
|
+
* @public
|
|
908
|
+
*/
|
|
909
|
+
export declare interface Logger extends Consola {
|
|
910
|
+
/**
|
|
911
|
+
* A logger method for deprecated symbols.
|
|
912
|
+
*
|
|
913
|
+
* @remarks
|
|
914
|
+
* Pair with a deprecated tag. See {@link https://tsdoc.org/pages/tags/deprecated/} for more information.
|
|
915
|
+
*
|
|
916
|
+
* @example
|
|
917
|
+
* ```ts
|
|
918
|
+
* logger.deprecated('someSymbol');
|
|
919
|
+
* ```
|
|
920
|
+
*
|
|
921
|
+
* @example With a custom instruction and target removal version.
|
|
922
|
+
* ```ts
|
|
923
|
+
* logger.deprecated('routeButtons', 'Use the default slot instead.', '20.0.0');
|
|
924
|
+
* ```
|
|
925
|
+
*
|
|
926
|
+
* @param symbol - The deprecated symbol.
|
|
927
|
+
* @param instruction - An optional alternative instruction. Defaults to `Consult docs for better alternative.`
|
|
928
|
+
* @param removalVersionTarget - An optional target removal version number.
|
|
929
|
+
*/
|
|
930
|
+
deprecated(symbol: string, instruction?: string, removalVersionTarget?: string): void;
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
/**
|
|
934
|
+
* A logger that extends the `Consola` logger.
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
export declare interface Logger extends Consola {
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
/**
|
|
941
|
+
* Options for creating a logger.
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
export declare interface LoggerOptions extends ConsolaOptions {
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
export { LogLevel }
|
|
948
|
+
|
|
949
|
+
/**
|
|
950
|
+
* @internal
|
|
951
|
+
*/
|
|
952
|
+
declare type LowercaseOperation = 'insert' | 'modify' | 'delete';
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* @public
|
|
956
|
+
*/
|
|
957
|
+
export declare class NumberParser {
|
|
958
|
+
/**
|
|
959
|
+
* reference: https://observablehq.com/\@mbostock/localized-number-parsing
|
|
960
|
+
* @internal
|
|
961
|
+
*/
|
|
962
|
+
private _group;
|
|
963
|
+
private _decimal;
|
|
964
|
+
private _separator;
|
|
965
|
+
private _numeral;
|
|
966
|
+
private _index;
|
|
967
|
+
constructor(locale: string);
|
|
968
|
+
parse(localeNumber: string): number;
|
|
969
|
+
hasSeparator(localeNumber: string): boolean;
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Represents an event observer that manages the subscription and publication of events.
|
|
974
|
+
* @public
|
|
975
|
+
*/
|
|
976
|
+
export declare interface Observer<EventType> {
|
|
977
|
+
subscribe: Subscribe<EventType>;
|
|
978
|
+
publish: Publish<EventType>;
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* Opens a new browser window with the specified URL, target, width, and height.
|
|
983
|
+
* @param urlNavigate - The URL to navigate to.
|
|
984
|
+
* @param target - The name of the new window.
|
|
985
|
+
* @param popUpWidth - The width of the new window (optional).
|
|
986
|
+
* @param popUpHeight - The height of the new window (optional).
|
|
987
|
+
* @returns A reference to the new window.
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
export declare const openPopup: (urlNavigate: string, target: string, popUpWidth?: number, popUpHeight?: number) => Window;
|
|
991
|
+
|
|
992
|
+
/**
|
|
993
|
+
* The `PendingState` mixin.
|
|
994
|
+
* @public
|
|
995
|
+
*/
|
|
996
|
+
export declare const PendingState: <TBase extends ConstructablePendingState>(Base: TBase) => {
|
|
997
|
+
new (...args: any[]): {
|
|
998
|
+
/**
|
|
999
|
+
* The number of promises that are currently pending.
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
pendingCount: number;
|
|
1003
|
+
/**
|
|
1004
|
+
* The number of promises that have been resolved.
|
|
1005
|
+
* @public
|
|
1006
|
+
*/
|
|
1007
|
+
resolvedCount: number;
|
|
1008
|
+
/**
|
|
1009
|
+
* A boolean indicating whether there are any pending children.
|
|
1010
|
+
* @public
|
|
1011
|
+
*/
|
|
1012
|
+
hasPendingChildren: boolean;
|
|
1013
|
+
/**
|
|
1014
|
+
* Gets the progress of the pending promises as a percentage between 0 and 1.
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
readonly progress: number;
|
|
1018
|
+
/**
|
|
1019
|
+
* Called when the element is connected to the DOM.
|
|
1020
|
+
* @internal
|
|
1021
|
+
*/
|
|
1022
|
+
connectedCallback(): void;
|
|
1023
|
+
/**
|
|
1024
|
+
* Called when the element is disconnected from the DOM.
|
|
1025
|
+
* @internal
|
|
1026
|
+
*/
|
|
1027
|
+
disconnectedCallback(): void;
|
|
1028
|
+
/**
|
|
1029
|
+
* Handles the `pending-state` event.
|
|
1030
|
+
* @param event - The `pending-state` event.
|
|
1031
|
+
* @internal
|
|
1032
|
+
*/
|
|
1033
|
+
onPendingState({ detail }: PendingStateEvent): Promise<void>;
|
|
1034
|
+
readonly $fastController: Controller;
|
|
1035
|
+
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
1036
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1037
|
+
accessKey: string;
|
|
1038
|
+
readonly accessKeyLabel: string;
|
|
1039
|
+
autocapitalize: string;
|
|
1040
|
+
dir: string;
|
|
1041
|
+
draggable: boolean;
|
|
1042
|
+
hidden: boolean;
|
|
1043
|
+
inert: boolean;
|
|
1044
|
+
innerText: string;
|
|
1045
|
+
lang: string;
|
|
1046
|
+
readonly offsetHeight: number;
|
|
1047
|
+
readonly offsetLeft: number;
|
|
1048
|
+
readonly offsetParent: Element;
|
|
1049
|
+
readonly offsetTop: number;
|
|
1050
|
+
readonly offsetWidth: number;
|
|
1051
|
+
outerText: string;
|
|
1052
|
+
spellcheck: boolean;
|
|
1053
|
+
title: string;
|
|
1054
|
+
translate: boolean;
|
|
1055
|
+
attachInternals(): ElementInternals;
|
|
1056
|
+
click(): void;
|
|
1057
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1058
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1059
|
+
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
1060
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1061
|
+
readonly attributes: NamedNodeMap;
|
|
1062
|
+
readonly classList: DOMTokenList;
|
|
1063
|
+
className: string;
|
|
1064
|
+
readonly clientHeight: number;
|
|
1065
|
+
readonly clientLeft: number;
|
|
1066
|
+
readonly clientTop: number;
|
|
1067
|
+
readonly clientWidth: number;
|
|
1068
|
+
id: string;
|
|
1069
|
+
readonly localName: string;
|
|
1070
|
+
readonly namespaceURI: string;
|
|
1071
|
+
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
1072
|
+
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
1073
|
+
outerHTML: string;
|
|
1074
|
+
readonly ownerDocument: Document;
|
|
1075
|
+
readonly part: DOMTokenList;
|
|
1076
|
+
readonly prefix: string;
|
|
1077
|
+
readonly scrollHeight: number;
|
|
1078
|
+
scrollLeft: number;
|
|
1079
|
+
scrollTop: number;
|
|
1080
|
+
readonly scrollWidth: number;
|
|
1081
|
+
readonly shadowRoot: ShadowRoot;
|
|
1082
|
+
slot: string;
|
|
1083
|
+
readonly tagName: string;
|
|
1084
|
+
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
1085
|
+
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
|
1086
|
+
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
|
1087
|
+
closest<E extends Element = Element>(selectors: string): E;
|
|
1088
|
+
getAttribute(qualifiedName: string): string;
|
|
1089
|
+
getAttributeNS(namespace: string, localName: string): string;
|
|
1090
|
+
getAttributeNames(): string[];
|
|
1091
|
+
getAttributeNode(qualifiedName: string): Attr;
|
|
1092
|
+
getAttributeNodeNS(namespace: string, localName: string): Attr;
|
|
1093
|
+
getBoundingClientRect(): DOMRect;
|
|
1094
|
+
getClientRects(): DOMRectList;
|
|
1095
|
+
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
|
1096
|
+
getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
|
|
1097
|
+
getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
|
|
1098
|
+
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
|
1099
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
1100
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
1101
|
+
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
1102
|
+
hasAttribute(qualifiedName: string): boolean;
|
|
1103
|
+
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
1104
|
+
hasAttributes(): boolean;
|
|
1105
|
+
hasPointerCapture(pointerId: number): boolean;
|
|
1106
|
+
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
1107
|
+
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
1108
|
+
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
1109
|
+
matches(selectors: string): boolean;
|
|
1110
|
+
releasePointerCapture(pointerId: number): void;
|
|
1111
|
+
removeAttribute(qualifiedName: string): void;
|
|
1112
|
+
removeAttributeNS(namespace: string, localName: string): void;
|
|
1113
|
+
removeAttributeNode(attr: Attr): Attr;
|
|
1114
|
+
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
1115
|
+
requestPointerLock(): void;
|
|
1116
|
+
scroll(options?: ScrollToOptions): void;
|
|
1117
|
+
scroll(x: number, y: number): void;
|
|
1118
|
+
scrollBy(options?: ScrollToOptions): void;
|
|
1119
|
+
scrollBy(x: number, y: number): void;
|
|
1120
|
+
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
1121
|
+
scrollTo(options?: ScrollToOptions): void;
|
|
1122
|
+
scrollTo(x: number, y: number): void;
|
|
1123
|
+
setAttribute(qualifiedName: string, value: string): void;
|
|
1124
|
+
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
1125
|
+
setAttributeNode(attr: Attr): Attr;
|
|
1126
|
+
setAttributeNodeNS(attr: Attr): Attr;
|
|
1127
|
+
setPointerCapture(pointerId: number): void;
|
|
1128
|
+
toggleAttribute(qualifiedName: string, force?: boolean): boolean;
|
|
1129
|
+
webkitMatchesSelector(selectors: string): boolean;
|
|
1130
|
+
readonly baseURI: string;
|
|
1131
|
+
readonly childNodes: NodeListOf<ChildNode>;
|
|
1132
|
+
readonly firstChild: ChildNode;
|
|
1133
|
+
readonly isConnected: boolean;
|
|
1134
|
+
readonly lastChild: ChildNode;
|
|
1135
|
+
readonly nextSibling: ChildNode;
|
|
1136
|
+
readonly nodeName: string;
|
|
1137
|
+
readonly nodeType: number;
|
|
1138
|
+
nodeValue: string;
|
|
1139
|
+
readonly parentElement: HTMLElement;
|
|
1140
|
+
readonly parentNode: ParentNode;
|
|
1141
|
+
readonly previousSibling: ChildNode;
|
|
1142
|
+
textContent: string;
|
|
1143
|
+
appendChild<T extends Node>(node: T): T;
|
|
1144
|
+
cloneNode(deep?: boolean): Node;
|
|
1145
|
+
compareDocumentPosition(other: Node): number;
|
|
1146
|
+
contains(other: Node): boolean;
|
|
1147
|
+
getRootNode(options?: GetRootNodeOptions): Node;
|
|
1148
|
+
hasChildNodes(): boolean;
|
|
1149
|
+
insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
|
|
1150
|
+
isDefaultNamespace(namespace: string): boolean;
|
|
1151
|
+
isEqualNode(otherNode: Node): boolean;
|
|
1152
|
+
isSameNode(otherNode: Node): boolean;
|
|
1153
|
+
lookupNamespaceURI(prefix: string): string;
|
|
1154
|
+
lookupPrefix(namespace: string): string;
|
|
1155
|
+
normalize(): void;
|
|
1156
|
+
removeChild<T_2 extends Node>(child: T_2): T_2;
|
|
1157
|
+
replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
|
|
1158
|
+
readonly ATTRIBUTE_NODE: number;
|
|
1159
|
+
readonly CDATA_SECTION_NODE: number;
|
|
1160
|
+
readonly COMMENT_NODE: number;
|
|
1161
|
+
readonly DOCUMENT_FRAGMENT_NODE: number;
|
|
1162
|
+
readonly DOCUMENT_NODE: number;
|
|
1163
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: number;
|
|
1164
|
+
readonly DOCUMENT_POSITION_CONTAINS: number;
|
|
1165
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: number;
|
|
1166
|
+
readonly DOCUMENT_POSITION_FOLLOWING: number;
|
|
1167
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
|
|
1168
|
+
readonly DOCUMENT_POSITION_PRECEDING: number;
|
|
1169
|
+
readonly DOCUMENT_TYPE_NODE: number;
|
|
1170
|
+
readonly ELEMENT_NODE: number;
|
|
1171
|
+
readonly ENTITY_NODE: number;
|
|
1172
|
+
readonly ENTITY_REFERENCE_NODE: number;
|
|
1173
|
+
readonly NOTATION_NODE: number;
|
|
1174
|
+
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
1175
|
+
readonly TEXT_NODE: number;
|
|
1176
|
+
dispatchEvent(event: Event): boolean;
|
|
1177
|
+
ariaAtomic: string;
|
|
1178
|
+
ariaAutoComplete: string;
|
|
1179
|
+
ariaBusy: string;
|
|
1180
|
+
ariaChecked: string;
|
|
1181
|
+
ariaColCount: string;
|
|
1182
|
+
ariaColIndex: string;
|
|
1183
|
+
ariaColIndexText: string;
|
|
1184
|
+
ariaColSpan: string;
|
|
1185
|
+
ariaCurrent: string;
|
|
1186
|
+
ariaDisabled: string;
|
|
1187
|
+
ariaExpanded: string;
|
|
1188
|
+
ariaHasPopup: string;
|
|
1189
|
+
ariaHidden: string;
|
|
1190
|
+
ariaInvalid: string;
|
|
1191
|
+
ariaKeyShortcuts: string;
|
|
1192
|
+
ariaLabel: string;
|
|
1193
|
+
ariaLevel: string;
|
|
1194
|
+
ariaLive: string;
|
|
1195
|
+
ariaModal: string;
|
|
1196
|
+
ariaMultiLine: string;
|
|
1197
|
+
ariaMultiSelectable: string;
|
|
1198
|
+
ariaOrientation: string;
|
|
1199
|
+
ariaPlaceholder: string;
|
|
1200
|
+
ariaPosInSet: string;
|
|
1201
|
+
ariaPressed: string;
|
|
1202
|
+
ariaReadOnly: string;
|
|
1203
|
+
ariaRequired: string;
|
|
1204
|
+
ariaRoleDescription: string;
|
|
1205
|
+
ariaRowCount: string;
|
|
1206
|
+
ariaRowIndex: string;
|
|
1207
|
+
ariaRowIndexText: string;
|
|
1208
|
+
ariaRowSpan: string;
|
|
1209
|
+
ariaSelected: string;
|
|
1210
|
+
ariaSetSize: string;
|
|
1211
|
+
ariaSort: string;
|
|
1212
|
+
ariaValueMax: string;
|
|
1213
|
+
ariaValueMin: string;
|
|
1214
|
+
ariaValueNow: string;
|
|
1215
|
+
ariaValueText: string;
|
|
1216
|
+
role: string;
|
|
1217
|
+
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation;
|
|
1218
|
+
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
1219
|
+
after(...nodes: (string | Node)[]): void;
|
|
1220
|
+
before(...nodes: (string | Node)[]): void;
|
|
1221
|
+
remove(): void;
|
|
1222
|
+
replaceWith(...nodes: (string | Node)[]): void;
|
|
1223
|
+
innerHTML: string;
|
|
1224
|
+
readonly nextElementSibling: Element;
|
|
1225
|
+
readonly previousElementSibling: Element;
|
|
1226
|
+
readonly childElementCount: number;
|
|
1227
|
+
readonly children: HTMLCollection;
|
|
1228
|
+
readonly firstElementChild: Element;
|
|
1229
|
+
readonly lastElementChild: Element;
|
|
1230
|
+
append(...nodes: (string | Node)[]): void;
|
|
1231
|
+
prepend(...nodes: (string | Node)[]): void;
|
|
1232
|
+
querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
|
|
1233
|
+
querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
|
|
1234
|
+
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
|
1235
|
+
querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
|
|
1236
|
+
querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
|
|
1237
|
+
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
|
1238
|
+
replaceChildren(...nodes: (string | Node)[]): void;
|
|
1239
|
+
readonly assignedSlot: HTMLSlotElement;
|
|
1240
|
+
oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
1241
|
+
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
1242
|
+
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
1243
|
+
readonly style: CSSStyleDeclaration;
|
|
1244
|
+
contentEditable: string;
|
|
1245
|
+
enterKeyHint: string;
|
|
1246
|
+
inputMode: string;
|
|
1247
|
+
readonly isContentEditable: boolean;
|
|
1248
|
+
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
1249
|
+
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
1250
|
+
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
1251
|
+
onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
1252
|
+
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
1253
|
+
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1254
|
+
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
|
1255
|
+
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
1256
|
+
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1257
|
+
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1258
|
+
oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1259
|
+
onchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1260
|
+
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1261
|
+
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1262
|
+
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1263
|
+
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1264
|
+
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1265
|
+
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1266
|
+
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1267
|
+
ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1268
|
+
ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1269
|
+
ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1270
|
+
ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1271
|
+
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
1272
|
+
ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1273
|
+
onemptied: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1274
|
+
onended: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1275
|
+
onerror: OnErrorEventHandlerNonNull;
|
|
1276
|
+
onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
1277
|
+
onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
|
|
1278
|
+
ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1279
|
+
oninput: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1280
|
+
oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1281
|
+
onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
1282
|
+
onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
1283
|
+
onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
1284
|
+
onload: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1285
|
+
onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1286
|
+
onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1287
|
+
onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1288
|
+
onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1289
|
+
onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1290
|
+
onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1291
|
+
onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1292
|
+
onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1293
|
+
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1294
|
+
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1295
|
+
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
1296
|
+
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1297
|
+
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1298
|
+
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1299
|
+
onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1300
|
+
onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1301
|
+
onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1302
|
+
onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1303
|
+
onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1304
|
+
onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1305
|
+
onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1306
|
+
onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
1307
|
+
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
1308
|
+
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1309
|
+
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1310
|
+
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
1311
|
+
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1312
|
+
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
1313
|
+
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1314
|
+
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1315
|
+
onselect: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1316
|
+
onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1317
|
+
onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1318
|
+
onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1319
|
+
onstalled: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1320
|
+
onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
|
|
1321
|
+
onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1322
|
+
ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1323
|
+
ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1324
|
+
ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
1325
|
+
ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
1326
|
+
ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
1327
|
+
ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
1328
|
+
ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
1329
|
+
ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
1330
|
+
ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
1331
|
+
ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
1332
|
+
onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1333
|
+
onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1334
|
+
onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1335
|
+
onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1336
|
+
onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1337
|
+
onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
1338
|
+
onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
|
|
1339
|
+
autofocus: boolean;
|
|
1340
|
+
readonly dataset: DOMStringMap;
|
|
1341
|
+
nonce?: string;
|
|
1342
|
+
tabIndex: number;
|
|
1343
|
+
blur(): void;
|
|
1344
|
+
focus(options?: FocusOptions): void;
|
|
1345
|
+
};
|
|
1346
|
+
} & TBase;
|
|
1347
|
+
|
|
1348
|
+
/**
|
|
1349
|
+
* A custom event that represents a `pending-state-error` event.
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
export declare type PendingStateErrorEvent = CustomEvent<PendingStateErrorEventData>;
|
|
1353
|
+
|
|
1354
|
+
/**
|
|
1355
|
+
* The data for a `pending-state-error` event.
|
|
1356
|
+
* @internal
|
|
1357
|
+
*/
|
|
1358
|
+
declare type PendingStateErrorEventData = {
|
|
1359
|
+
message?: string;
|
|
1360
|
+
error: Error;
|
|
1361
|
+
};
|
|
1362
|
+
|
|
1363
|
+
/**
|
|
1364
|
+
* A custom event that represents a `pending-state` event.
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
export declare type PendingStateEvent = CustomEvent<PendingStateEventData>;
|
|
1368
|
+
|
|
1369
|
+
/**
|
|
1370
|
+
* The data for a `pending-state` event.
|
|
1371
|
+
* @internal
|
|
1372
|
+
*/
|
|
1373
|
+
declare type PendingStateEventData = {
|
|
1374
|
+
promise: Promise<void>;
|
|
1375
|
+
};
|
|
1376
|
+
|
|
1377
|
+
/**
|
|
1378
|
+
* An enum that defines the names of the events that can be raised by the `PendingState` mixin.
|
|
1379
|
+
* @public
|
|
1380
|
+
*/
|
|
1381
|
+
export declare enum PendingStateEvents {
|
|
1382
|
+
state = "pending-state",
|
|
1383
|
+
error = "pending-state-error"
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
* The default height (in pixels) for pop-up windows.
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
export declare const POPUP_DEFAULT_HEIGHT = 600;
|
|
1391
|
+
|
|
1392
|
+
/**
|
|
1393
|
+
* The default width (in pixels) for pop-up windows.
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
export declare const POPUP_DEFAULT_WIDTH = 483;
|
|
1397
|
+
|
|
1398
|
+
/**
|
|
1399
|
+
* Publishes an event of a specific type to all subscribed listeners.
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
export declare type Publish<EventType> = (event: EventType) => void;
|
|
1403
|
+
|
|
1404
|
+
/**
|
|
1405
|
+
* Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.
|
|
1406
|
+
*
|
|
1407
|
+
* @remarks
|
|
1408
|
+
* This is useful if you have a lot of properties that all invalidate the internal state.
|
|
1409
|
+
* See {@link https://www.fast.design/docs/fast-element/observables-and-state#internal-observation} for more information.
|
|
1410
|
+
*
|
|
1411
|
+
* @param target - The target to define the property change handler on.
|
|
1412
|
+
* @param name - The property name.
|
|
1413
|
+
*
|
|
1414
|
+
* @example
|
|
1415
|
+
* ```ts
|
|
1416
|
+
* @attr({ mode: 'boolean', attribute: 'line-numbers' })
|
|
1417
|
+
* @renderOnChange
|
|
1418
|
+
* lineNumbers: boolean = true;
|
|
1419
|
+
*
|
|
1420
|
+
* @attr
|
|
1421
|
+
* @renderOnChange
|
|
1422
|
+
* indent: number | 'tab' = 2;
|
|
1423
|
+
*
|
|
1424
|
+
* render() {
|
|
1425
|
+
* if (!this.$fastController.isConnected) {
|
|
1426
|
+
* return;
|
|
1427
|
+
* }
|
|
1428
|
+
* // Do something...
|
|
1429
|
+
* }
|
|
1430
|
+
* ```
|
|
1431
|
+
*
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
export declare function renderOnChange(target: FASTElement & {
|
|
1435
|
+
render(): void;
|
|
1436
|
+
}, name: string): void;
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* An object that defines two resource types: "local" and "remote".
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
export declare const ResourceType: {
|
|
1443
|
+
readonly local: "local";
|
|
1444
|
+
readonly remote: "remote";
|
|
1445
|
+
};
|
|
1446
|
+
|
|
1447
|
+
/**
|
|
1448
|
+
* A type that represents the resource types defined by the `ResourceType` object.
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
export declare type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
1452
|
+
|
|
1453
|
+
/**
|
|
1454
|
+
* Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen
|
|
1455
|
+
* @param element - HTMLElement to observe
|
|
1456
|
+
* @param callback - any function called when the visibility changes
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
export declare const respondToVisibility: (element: HTMLElement, callback: (arg0: boolean) => any) => void;
|
|
1460
|
+
|
|
1461
|
+
/**
|
|
1462
|
+
* The data for a server row DTO.
|
|
1463
|
+
* @public
|
|
1464
|
+
*/
|
|
1465
|
+
export declare type ServerRowDTO = {
|
|
1466
|
+
DETAILS: {
|
|
1467
|
+
OPERATION: UppercaseOperation;
|
|
1468
|
+
ROW_REF: string;
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
|
|
1472
|
+
/**
|
|
1473
|
+
* A mapper for converting between server row DTOs and entities.
|
|
1474
|
+
* Provides methods to get/set a ServerRow DTO entity mapping.
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1477
|
+
export declare interface ServerRowDTOMapper extends DTOMapper<ServerRowDTO, ServerRowEntity> {
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* A DI token used to obtain a `ServerRowDTOMapper` instance.
|
|
1482
|
+
* @public
|
|
1483
|
+
*/
|
|
1484
|
+
export declare const ServerRowDTOMapper: InterfaceSymbol<ServerRowDTOMapper>;
|
|
1485
|
+
|
|
1486
|
+
/**
|
|
1487
|
+
* The data for a server row entity.
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
export declare type ServerRowEntity = {
|
|
1491
|
+
serverRowMetadata: {
|
|
1492
|
+
operation: LowercaseOperation;
|
|
1493
|
+
rowRef: string;
|
|
1494
|
+
};
|
|
1495
|
+
};
|
|
1496
|
+
|
|
1497
|
+
/**
|
|
1498
|
+
* A custom element that encapsulates a set of styles that can be applied to slotted elements.
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
export declare class SlottedStyles extends FASTElement {
|
|
1502
|
+
/**
|
|
1503
|
+
* The styles to apply to slotted elements.
|
|
1504
|
+
*/
|
|
1505
|
+
styles: ElementStyles;
|
|
1506
|
+
/**
|
|
1507
|
+
* Called when the `styles` property changes.
|
|
1508
|
+
* Removes the previous styles from the parent element's FAST controller and adds the new styles.
|
|
1509
|
+
* @param prev - The previous value of the `styles` property.
|
|
1510
|
+
* @param next - The new value of the `styles` property.
|
|
1511
|
+
*/
|
|
1512
|
+
stylesChanged(prev: ElementStyles, next: ElementStyles): void;
|
|
1513
|
+
}
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* The sub-path used for WebSocket connections.
|
|
1517
|
+
* Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.
|
|
1518
|
+
* @remarks Optional. Default is "API_HOST/gwf"
|
|
1519
|
+
* @public
|
|
1520
|
+
*/
|
|
1521
|
+
export declare let SOCKET_EXT: string;
|
|
1522
|
+
|
|
1523
|
+
/**
|
|
1524
|
+
* Subscribes a listener function to receive events of a specific type.
|
|
1525
|
+
* @public
|
|
1526
|
+
*/
|
|
1527
|
+
export declare type Subscribe<EventType> = (listener: Listener<EventType>) => () => void;
|
|
1528
|
+
|
|
1529
|
+
/**
|
|
1530
|
+
* Creates a synchronization directive that binds a data source to an HTML element,
|
|
1531
|
+
* @public
|
|
1532
|
+
*/
|
|
1533
|
+
export declare function sync<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, conversionType?: ConversionType, eventName?: EventName, keyAttr?: string): CaptureType<TSource>;
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* An object containing type ramp values.
|
|
1537
|
+
* @public
|
|
1538
|
+
*/
|
|
1539
|
+
export declare const TypeRampValues: {
|
|
1540
|
+
readonly minusOne: -1;
|
|
1541
|
+
readonly minusTwo: -2;
|
|
1542
|
+
readonly plusOne: 1;
|
|
1543
|
+
readonly plusTwo: 2;
|
|
1544
|
+
readonly plusThree: 3;
|
|
1545
|
+
readonly plusFour: 4;
|
|
1546
|
+
readonly plusFive: 5;
|
|
1547
|
+
readonly plusSix: 6;
|
|
1548
|
+
};
|
|
1549
|
+
|
|
1550
|
+
/**
|
|
1551
|
+
* @internal
|
|
1552
|
+
*/
|
|
1553
|
+
declare type UppercaseOperation = Uppercase<LowercaseOperation>;
|
|
1554
|
+
|
|
1555
|
+
/**
|
|
1556
|
+
* An interface for generating UUIDs.
|
|
1557
|
+
* @public
|
|
1558
|
+
*/
|
|
1559
|
+
export declare interface UUID {
|
|
1560
|
+
/**
|
|
1561
|
+
* Generates a new UUID.
|
|
1562
|
+
* @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
|
|
1563
|
+
* @returns The generated UUID.
|
|
1564
|
+
*/
|
|
1565
|
+
createId(withLogging?: boolean): string;
|
|
1566
|
+
/**
|
|
1567
|
+
* Generates a new UUID for a remote object.
|
|
1568
|
+
* @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
|
|
1569
|
+
* @returns A promise that resolves to the generated UUID.
|
|
1570
|
+
*/
|
|
1571
|
+
createRemoteId(withLogging?: boolean): Promise<string>;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
/**
|
|
1575
|
+
* A dependency injection token for the UUID interface.
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
export declare const UUID: InterfaceSymbol<UUID>;
|
|
1579
|
+
|
|
1580
|
+
/**
|
|
1581
|
+
* A configuration object for customizing UUID generation.
|
|
1582
|
+
* @public
|
|
1583
|
+
*/
|
|
1584
|
+
export declare interface UUIDConfig {
|
|
1585
|
+
}
|
|
1586
|
+
|
|
1587
|
+
/**
|
|
1588
|
+
* Directive that allows supplying an "else" template to the traditional {@link https://www.fast.design/docs/api/fast-element.when/#when-function} directive
|
|
1589
|
+
*
|
|
1590
|
+
* @param binding - The condition to test for rendering.
|
|
1591
|
+
* @param trueTemplateOrTemplateBinding - The template or a binding that gets the template to render when the condition is true.
|
|
1592
|
+
* @param falseTemplateOrTemplateBinding - The template or a binding that gets the template to render when the condition is false.
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
export declare function whenElse<TSource = any, TReturn = any>(binding: Binding<TSource, TReturn>, trueTemplateOrTemplateBinding: WhenTemplate<TSource>, falseTemplateOrTemplateBinding: WhenTemplate<TSource>): CaptureType<TSource>;
|
|
1596
|
+
|
|
1597
|
+
declare type WhenTemplate<TSource> = SyntheticViewTemplate | Binding<TSource, SyntheticViewTemplate>;
|
|
1598
|
+
|
|
1599
|
+
export { }
|