@eui/base 23.0.0-alpha.2 → 23.0.0-alpha.4
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/docs/architecture.html +223 -0
- package/docs/changelog.html +126 -2
- package/docs/classes/ConsoleAppender.html +76 -27
- package/docs/classes/EuiEuLanguages.html +55 -16
- package/docs/classes/EuiLazyService.html +86 -25
- package/docs/classes/EuiPagination.html +69 -16
- package/docs/classes/EuiService.html +103 -28
- package/docs/classes/LogAppender.html +52 -20
- package/docs/classes/Logger.html +100 -30
- package/docs/classes/LoggerMock.html +92 -22
- package/docs/classes/UrlAppender.html +78 -24
- package/docs/classes/UxBadgeLegacy.html +47 -16
- package/docs/classes/UxClearErrorFeedbackEvent.html +47 -16
- package/docs/classes/UxErrorGroupOnClickEvent.html +47 -16
- package/docs/classes/UxErrorOutput.html +91 -24
- package/docs/classes/UxLinkLegacy.html +105 -31
- package/docs/classes/UxPublishErrorFeedbackEvent.html +49 -16
- package/docs/classes/UxValidationErrorClass.html +77 -18
- package/docs/dependencies.html +38 -4
- package/docs/index.html +26 -2
- package/docs/interfaces/ApiQueue.html +41 -11
- package/docs/interfaces/ApiQueueItem.html +209 -181
- package/docs/interfaces/AppState.html +312 -284
- package/docs/interfaces/ConnectionStatus.html +134 -93
- package/docs/interfaces/ConsoleAppenderConfig.html +206 -104
- package/docs/interfaces/ConsoleAppenderTypeConfig.html +253 -53
- package/docs/interfaces/CoreState.html +272 -244
- package/docs/interfaces/EnvDynamicConfig.html +218 -190
- package/docs/interfaces/EuiAppHandlersConfig.html +229 -201
- package/docs/interfaces/EuiAppJsonConfig.html +171 -143
- package/docs/interfaces/EuiAuthConfig.html +184 -156
- package/docs/interfaces/EuiConfig.html +131 -103
- package/docs/interfaces/EuiEnvConfig.html +180 -152
- package/docs/interfaces/EuiGlobalConfig.html +140 -112
- package/docs/interfaces/EuiGrowlMessage.html +408 -380
- package/docs/interfaces/EuiLanguage.html +169 -141
- package/docs/interfaces/EuiMenuItem.html +1708 -1653
- package/docs/interfaces/EuiPaginationConfig.html +228 -200
- package/docs/interfaces/EuiServiceModel.html +109 -67
- package/docs/interfaces/EuiServiceStatus.html +138 -108
- package/docs/interfaces/EuiStoreServiceModel.html +64 -36
- package/docs/interfaces/EuiUserRight.html +127 -99
- package/docs/interfaces/GlobalConfig.html +268 -240
- package/docs/interfaces/HttpErrorHandlerConfig.html +96 -68
- package/docs/interfaces/HttpErrorRouteConfig.html +136 -108
- package/docs/interfaces/I18nConfig.html +157 -129
- package/docs/interfaces/I18nLoaderConfig.html +199 -152
- package/docs/interfaces/I18nResource.html +176 -148
- package/docs/interfaces/I18nServiceConfig.html +141 -113
- package/docs/interfaces/I18nState.html +91 -63
- package/docs/interfaces/LoadedConfigModules.html +137 -107
- package/docs/interfaces/LocaleServiceConfig.html +102 -74
- package/docs/interfaces/LocaleState.html +96 -68
- package/docs/interfaces/LogAppenderConfig.html +123 -70
- package/docs/interfaces/LogAppenderTypeConfig.html +159 -61
- package/docs/interfaces/LogConfig.html +196 -149
- package/docs/interfaces/LogEvent.html +246 -199
- package/docs/interfaces/LogPosition.html +151 -123
- package/docs/interfaces/ModuleConfig.html +236 -12
- package/docs/interfaces/ModulesConfig.html +41 -11
- package/docs/interfaces/NotificationsState.html +98 -70
- package/docs/interfaces/UrlAppenderConfig.html +200 -98
- package/docs/interfaces/UrlAppenderTypeConfig.html +247 -53
- package/docs/interfaces/UrlLogEvent.html +368 -96
- package/docs/interfaces/UserConfig.html +97 -69
- package/docs/interfaces/UserDetails.html +237 -190
- package/docs/interfaces/UserPreferences.html +141 -113
- package/docs/interfaces/UserState.html +326 -279
- package/docs/interfaces/UxErrorFeedback.html +373 -235
- package/docs/interfaces/UxErrorFollowMap.html +41 -11
- package/docs/interfaces/UxErrorInfo.html +201 -151
- package/docs/interfaces/UxErrorMessage.html +149 -102
- package/docs/interfaces/UxFormValidationError.html +91 -63
- package/docs/interfaces/UxHttpErrorInfo.html +112 -65
- package/docs/interfaces/UxHttpErrorResponse.html +108 -61
- package/docs/interfaces/UxModalLegacy.html +164 -136
- package/docs/interfaces/UxValidationErrorAttribute.html +121 -93
- package/docs/interfaces/UxValidationErrorFeedback.html +126 -98
- package/docs/interfaces/UxValidationErrorI18nMessage.html +127 -99
- package/docs/interfaces/VersionsConfig.html +96 -68
- package/docs/interfaces/XHRConfig.html +346 -318
- package/docs/js/architecture-graph.js +288 -0
- package/docs/js/libs/bootstrap-native.js +4 -2
- package/docs/js/libs/tablesort.min.js +3 -3
- package/docs/js/libs/tablesort.number.min.js +2 -2
- package/docs/js/libs/vis-network.min.js +7 -7
- package/docs/js/menu-wc.js +30 -23
- package/docs/js/routes.js +138 -37
- package/docs/js/search/search.js +62 -0
- package/docs/js/search/search_index.js +2 -2
- package/docs/js/tabs.js +98 -15
- package/docs/js/tree.js +44 -7
- package/docs/json/documentation.json +3154 -482
- package/docs/license.html +26 -2
- package/docs/llms.txt +1084 -0
- package/docs/miscellaneous/enumerations.html +30 -6
- package/docs/miscellaneous/functions.html +138 -27
- package/docs/miscellaneous/typealiases.html +62 -29
- package/docs/miscellaneous/variables.html +77 -53
- package/docs/modules.html +26 -2
- package/docs/overview.html +26 -2
- package/docs/properties.html +27 -3
- package/docs/routes.html +26 -2
- package/docs/styles/compodoc.css +365 -44
- package/docs/styles/dark.css +16 -0
- package/docs/template-playground/hbs-render.service.ts +6 -1
- package/package.json +1 -1
- package/docs/js/menu-wc_es5.js +0 -40
package/docs/llms.txt
ADDED
|
@@ -0,0 +1,1084 @@
|
|
|
1
|
+
# eui documentation
|
|
2
|
+
|
|
3
|
+
> Generated by compodoc 2.0.0 at 2026-07-09T11:29:31.464Z, llm-md export.
|
|
4
|
+
|
|
5
|
+
## Classes
|
|
6
|
+
|
|
7
|
+
### ConsoleAppender
|
|
8
|
+
|
|
9
|
+
File: `packages/base/src/lib/eui-models/log/console.appender.ts`
|
|
10
|
+
Extends: `LogAppender<ConsoleAppenderConfig>`
|
|
11
|
+
|
|
12
|
+
Description: Console Appender
|
|
13
|
+
|
|
14
|
+
Properties:
|
|
15
|
+
- `config: ConsoleAppenderConfig`
|
|
16
|
+
|
|
17
|
+
Methods:
|
|
18
|
+
- `append(event: LogEvent): void` — Logs an event in the console
|
|
19
|
+
- `getConfig(): CFG` — Gets the config
|
|
20
|
+
|
|
21
|
+
### EuiEuLanguages
|
|
22
|
+
|
|
23
|
+
File: `packages/base/src/lib/eui-models/eui-language/eui-eu-languages.model.ts`
|
|
24
|
+
|
|
25
|
+
Methods:
|
|
26
|
+
- `filterEULanguages(array: EuiLanguage[]): EuiLanguage[]` — filter EU Languages from given array
|
|
27
|
+
- `filterInvalidLanguageCodes(codes: EuiLanguageCode[]): EuiLanguageCode[]` — filters and removes language codes that are not part of the EULanguage e.g. 'ko' does not map to any EULanguage code on the array. { code: 'ko', label: 'whatever' } is valid though
|
|
28
|
+
- `filterNonEULanguages(array: EuiLanguage[]): EuiLanguage[]` — filter non EU languages from given array
|
|
29
|
+
- `getAllLanguagesByCodes(codes: string[]): EuiLanguage[]` — Returns array of EuiLanguage that match the given codes. If codes array is empty, returns all languages.
|
|
30
|
+
- `getLanguageByCode(code: string): EuiLanguage`
|
|
31
|
+
- `getLanguageCodes(array: EuiLanguageCode[]): string[]` — retrieve language codes (string array) from a given array of string and EuiLanguage items
|
|
32
|
+
- `getLanguages(codes: EuiLanguageCode[] = Object.keys(this.languages)): EuiLanguage[]` — Matches the given string array to the EU languages and returns a EuiLanguage array. In case that no codes provided it returns the EU Languages array.
|
|
33
|
+
- `getOrderedLanguages(codes: EuiLanguageCode[] = Object.keys(this.languages)): EuiLanguage[]` — return the given list ordered based on the EULanguage order
|
|
34
|
+
- `isEuLanguage(code: string): boolean`
|
|
35
|
+
|
|
36
|
+
### EuiLazyService
|
|
37
|
+
|
|
38
|
+
File: `packages/base/src/lib/eui-models/eui-service.model.ts`
|
|
39
|
+
Extends: `EuiService<T>`
|
|
40
|
+
|
|
41
|
+
Properties:
|
|
42
|
+
- `onStateChange: Subject<T> = new Subject<T>()`
|
|
43
|
+
|
|
44
|
+
Methods:
|
|
45
|
+
- `initEuiService(storeForLazyLoad?: EuiStoreServiceModel<T>): void`
|
|
46
|
+
- `lazyLoadInit(moduleConfig: ModuleConfig, moduleName?: string): Observable<EuiServiceStatus>`
|
|
47
|
+
- `getState(): Observable<T>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
48
|
+
- `init(t?: T): Observable<EuiServiceStatus>`
|
|
49
|
+
- `updateState(t: DeepPartial<T>): void`
|
|
50
|
+
|
|
51
|
+
### EuiPagination
|
|
52
|
+
|
|
53
|
+
File: `packages/base/src/lib/eui-models/eui-pagination/eui-pagination.model.ts`
|
|
54
|
+
|
|
55
|
+
Methods:
|
|
56
|
+
- `create(config: EuiPaginationConfig = DefaultConfig): EuiPagination`
|
|
57
|
+
- `getCurrentPage(): number`
|
|
58
|
+
- `getFirstPage(): number`
|
|
59
|
+
- `getLastPage(): number`
|
|
60
|
+
- `getPages(): Array<number>`
|
|
61
|
+
- `getPagesCount(): number`
|
|
62
|
+
- `getPageSize(): number`
|
|
63
|
+
- `getPageWindowSize(): number`
|
|
64
|
+
- `getShowingFrom(): number`
|
|
65
|
+
- `getShowingTo(): number`
|
|
66
|
+
- `getTotalItems(): number`
|
|
67
|
+
- `goToFirstPage(): void`
|
|
68
|
+
- `goToLastPage(): void`
|
|
69
|
+
- `goToNextPage(): void`
|
|
70
|
+
- `goToPage(page: number): void`
|
|
71
|
+
- `goToPreviousPage(): void`
|
|
72
|
+
- `hasItems(): boolean`
|
|
73
|
+
- `hasNextPage(): boolean`
|
|
74
|
+
- `hasPreviousPage(): boolean`
|
|
75
|
+
- `isFirstPageActive(): boolean`
|
|
76
|
+
- `isLastPageActive(): boolean`
|
|
77
|
+
- `setPageSize(size: number): void`
|
|
78
|
+
- `setPageWindowSize(size: number): void`
|
|
79
|
+
|
|
80
|
+
### EuiService
|
|
81
|
+
|
|
82
|
+
File: `packages/base/src/lib/eui-models/eui-service.model.ts`
|
|
83
|
+
|
|
84
|
+
Properties:
|
|
85
|
+
- `onStateChange: Subject<T> = new Subject<T>()`
|
|
86
|
+
|
|
87
|
+
Methods:
|
|
88
|
+
- `getState(): Observable<T>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
89
|
+
- `getState(mapFn?: function): Observable<K>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
90
|
+
- `getState(key?: A): Observable<T['A']>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
91
|
+
- `getState(keyOrMapFn?: unknown | string): Observable<K>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
92
|
+
- `init(t?: T): Observable<EuiServiceStatus>`
|
|
93
|
+
- `initEuiService(): void`
|
|
94
|
+
- `updateState(t: DeepPartial<T>): void`
|
|
95
|
+
|
|
96
|
+
### LogAppender
|
|
97
|
+
|
|
98
|
+
File: `packages/base/src/lib/eui-models/log/log.appender.ts`
|
|
99
|
+
|
|
100
|
+
Description: Abstract Log Appender
|
|
101
|
+
|
|
102
|
+
Methods:
|
|
103
|
+
- `append(event: LogEvent): void` — Logs a Log Event
|
|
104
|
+
- `getConfig(): CFG` — Gets the config
|
|
105
|
+
|
|
106
|
+
### Logger
|
|
107
|
+
|
|
108
|
+
File: `packages/base/src/lib/eui-models/log/log.logger.ts`
|
|
109
|
+
|
|
110
|
+
Description: Logger
|
|
111
|
+
|
|
112
|
+
Properties:
|
|
113
|
+
- `isAllEnabled: unknown = () => {...}`
|
|
114
|
+
- `isDebugEnabled: unknown = () => {...}`
|
|
115
|
+
- `isDisabled: unknown = () => {...}`
|
|
116
|
+
- `isEnabledFor: unknown = () => {...}`
|
|
117
|
+
- `isErrorEnabled: unknown = () => {...}`
|
|
118
|
+
- `isFatalEnabled: unknown = () => {...}`
|
|
119
|
+
- `isInfoEnabled: unknown = () => {...}`
|
|
120
|
+
- `isTraceEnabled: unknown = () => {...}`
|
|
121
|
+
- `isWarnEnabled: unknown = () => {...}`
|
|
122
|
+
|
|
123
|
+
Methods:
|
|
124
|
+
- `debug(message: M, ...additionalMessages: A[]): void` — Debug log
|
|
125
|
+
- `error(message: M, ...additionalMessages: A[]): void` — Error log
|
|
126
|
+
- `fatal(message: T, ...additionalMessages: S[]): void` — Fatal log
|
|
127
|
+
- `getLevel(): LogLevel` — Gets the log level
|
|
128
|
+
- `getName(): string` — Gets the logger name
|
|
129
|
+
- `info(message: M, ...additionalMessages: A[]): void` — Info log
|
|
130
|
+
- `isEnabledFor(enabledFromLevel: LogLevel, level: LogLevel): boolean`
|
|
131
|
+
- `setLevel(level: LogLevel): void` — Sets the log level
|
|
132
|
+
- `trace(message: M, ...additionalMessages: A[]): void` — Trace log
|
|
133
|
+
- `warn(message: M, ...additionalMessages: A[]): void` — Warning log
|
|
134
|
+
|
|
135
|
+
### LoggerMock
|
|
136
|
+
|
|
137
|
+
File: `packages/base/src/lib/eui-models/log/log.logger.mock.ts`
|
|
138
|
+
Extends: `Logger`
|
|
139
|
+
|
|
140
|
+
Properties:
|
|
141
|
+
- `isAllEnabled: unknown = () => {...}`
|
|
142
|
+
- `isDebugEnabled: unknown = () => {...}`
|
|
143
|
+
- `isDisabled: unknown = () => {...}`
|
|
144
|
+
- `isEnabledFor: unknown = () => {...}`
|
|
145
|
+
- `isErrorEnabled: unknown = () => {...}`
|
|
146
|
+
- `isFatalEnabled: unknown = () => {...}`
|
|
147
|
+
- `isInfoEnabled: unknown = () => {...}`
|
|
148
|
+
- `isTraceEnabled: unknown = () => {...}`
|
|
149
|
+
- `isWarnEnabled: unknown = () => {...}`
|
|
150
|
+
|
|
151
|
+
Methods:
|
|
152
|
+
- `debug(): void`
|
|
153
|
+
- `error(): void`
|
|
154
|
+
- `fatal(): void`
|
|
155
|
+
- `getLevel()`
|
|
156
|
+
- `info(): void`
|
|
157
|
+
- `setLevel(): void`
|
|
158
|
+
- `trace(): void`
|
|
159
|
+
- `warn(): void`
|
|
160
|
+
- `getName(): string` — Gets the logger name
|
|
161
|
+
- `isEnabledFor(enabledFromLevel: LogLevel, level: LogLevel): boolean`
|
|
162
|
+
|
|
163
|
+
### UrlAppender
|
|
164
|
+
|
|
165
|
+
File: `packages/base/src/lib/eui-models/log/url.appender.ts`
|
|
166
|
+
Extends: `LogAppender<UrlAppenderConfig>`
|
|
167
|
+
|
|
168
|
+
Description: Url Appender
|
|
169
|
+
|
|
170
|
+
Properties:
|
|
171
|
+
- `config: UrlAppenderConfig`
|
|
172
|
+
|
|
173
|
+
Methods:
|
|
174
|
+
- `append(event: LogEvent): void` — Logs an event to a server
|
|
175
|
+
- `getConfig(): CFG` — Gets the config
|
|
176
|
+
|
|
177
|
+
### UxBadgeLegacy
|
|
178
|
+
|
|
179
|
+
File: `packages/base/src/lib/ux-models/ux-link-legacy.model.ts`
|
|
180
|
+
|
|
181
|
+
Properties:
|
|
182
|
+
- `label: string`
|
|
183
|
+
- `typeClass: string = 'secondary'`
|
|
184
|
+
|
|
185
|
+
### UxClearErrorFeedbackEvent
|
|
186
|
+
|
|
187
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
188
|
+
|
|
189
|
+
Properties:
|
|
190
|
+
- `groupId?: string`
|
|
191
|
+
- `id?: string`
|
|
192
|
+
|
|
193
|
+
### UxErrorGroupOnClickEvent
|
|
194
|
+
|
|
195
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
196
|
+
|
|
197
|
+
Properties:
|
|
198
|
+
- `err?: UxErrorFeedback`
|
|
199
|
+
- `groupId: string`
|
|
200
|
+
|
|
201
|
+
### UxErrorOutput
|
|
202
|
+
|
|
203
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
204
|
+
|
|
205
|
+
Properties:
|
|
206
|
+
- `code?: string`
|
|
207
|
+
- `description: string`
|
|
208
|
+
- `details?: DETAILS`
|
|
209
|
+
- `doc?: string`
|
|
210
|
+
- `errGroupMap?: Array<UxErrorGroupMap>`
|
|
211
|
+
- `msgId: string`
|
|
212
|
+
- `requestId?: string`
|
|
213
|
+
- `severity: unknown = UxMessageSeverity.danger`
|
|
214
|
+
- `subErrors?: SubErrors`
|
|
215
|
+
|
|
216
|
+
Methods:
|
|
217
|
+
- `getFeedBacks(byKey?: string): Array<UxErrorFeedback>`
|
|
218
|
+
|
|
219
|
+
### UxLinkLegacy
|
|
220
|
+
|
|
221
|
+
File: `packages/base/src/lib/ux-models/ux-link-legacy.model.ts`
|
|
222
|
+
|
|
223
|
+
Properties:
|
|
224
|
+
- `active: unknown = false`
|
|
225
|
+
- `allowedRightId: string`
|
|
226
|
+
- `allowedRightIds: string[]`
|
|
227
|
+
- `ariaIconLabel: string`
|
|
228
|
+
- `badgeLabel: string`
|
|
229
|
+
- `badges: UxBadgeLegacy[]`
|
|
230
|
+
- `badgeTypeClass: string = 'secondary'`
|
|
231
|
+
- `category: string`
|
|
232
|
+
- `children: UxLinkLegacy<METADATA>[]`
|
|
233
|
+
- `command: function`
|
|
234
|
+
- `deniedRightId: string`
|
|
235
|
+
- `deniedRightIds: string[]`
|
|
236
|
+
- `disabled: unknown = false`
|
|
237
|
+
- `e2eAttr: string`
|
|
238
|
+
- `expanded: unknown = false`
|
|
239
|
+
- `hasIconBg: unknown = false`
|
|
240
|
+
- `hasMarker: unknown = false`
|
|
241
|
+
- `hasTag: unknown = false`
|
|
242
|
+
- `iconClass: string`
|
|
243
|
+
- `iconTypeClass: string`
|
|
244
|
+
- `id: string`
|
|
245
|
+
- `indeterminate: unknown = false`
|
|
246
|
+
- `isHome: unknown = false`
|
|
247
|
+
- `isScreenReaderClickable: unknown = false`
|
|
248
|
+
- `isSeparator: unknown = false`
|
|
249
|
+
- `label: string`
|
|
250
|
+
- `markerTypeClass: string`
|
|
251
|
+
- `metadata: METADATA`
|
|
252
|
+
- `parent: UxLinkLegacy<METADATA>`
|
|
253
|
+
- `selected: unknown = false`
|
|
254
|
+
- `subLabel: string`
|
|
255
|
+
- `tagCount: string`
|
|
256
|
+
- `tagLabel: string`
|
|
257
|
+
- `tagTypeClass: string`
|
|
258
|
+
- `tooltipLabel: string`
|
|
259
|
+
- `typeClass: string`
|
|
260
|
+
- `typeLabel: string`
|
|
261
|
+
- `typeLabelClass: string`
|
|
262
|
+
- `url: string`
|
|
263
|
+
- `urlExternal: string`
|
|
264
|
+
- `urlExternalTarget: string = '_blank'`
|
|
265
|
+
- `visible: unknown = true`
|
|
266
|
+
|
|
267
|
+
### UxPublishErrorFeedbackEvent
|
|
268
|
+
|
|
269
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
270
|
+
|
|
271
|
+
Properties:
|
|
272
|
+
- `accumulate?: boolean`
|
|
273
|
+
- `err: UxErrorOutput`
|
|
274
|
+
- `groupId?: string`
|
|
275
|
+
- `id?: string`
|
|
276
|
+
|
|
277
|
+
### UxValidationErrorClass
|
|
278
|
+
|
|
279
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
280
|
+
|
|
281
|
+
Properties:
|
|
282
|
+
- `attributes: UxValidationErrorAttributes`
|
|
283
|
+
- `br?: string`
|
|
284
|
+
- `description?: string`
|
|
285
|
+
- `details?: Details`
|
|
286
|
+
- `doc?: string`
|
|
287
|
+
- `errGroupId?: string`
|
|
288
|
+
- `msgId: string`
|
|
289
|
+
- `severity: unknown = UxMessageSeverity.danger`
|
|
290
|
+
|
|
291
|
+
## Interfaces
|
|
292
|
+
|
|
293
|
+
### ApiQueue
|
|
294
|
+
|
|
295
|
+
File: `packages/base/src/lib/eui-models/eui-store/models/app.models.ts`
|
|
296
|
+
|
|
297
|
+
### ApiQueueItem
|
|
298
|
+
|
|
299
|
+
File: `packages/base/src/lib/eui-models/eui-store/models/app.models.ts`
|
|
300
|
+
|
|
301
|
+
Properties:
|
|
302
|
+
- `method: HTTPMethod | string`
|
|
303
|
+
- `payload?: PAYLOAD`
|
|
304
|
+
- `timestamp?: number`
|
|
305
|
+
- `uri: string`
|
|
306
|
+
|
|
307
|
+
### AppState
|
|
308
|
+
|
|
309
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/app.state.ts`
|
|
310
|
+
|
|
311
|
+
Properties:
|
|
312
|
+
- `apiQueue?: ApiQueue`
|
|
313
|
+
- `connected?: boolean` — flag to indicate if the application is online/offline. Default: true
|
|
314
|
+
- `currentModule?: string`
|
|
315
|
+
- `loadedConfigModules?: LoadedConfigModules`
|
|
316
|
+
- `status?: string`
|
|
317
|
+
- `version?: string`
|
|
318
|
+
|
|
319
|
+
### ConnectionStatus
|
|
320
|
+
|
|
321
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
322
|
+
|
|
323
|
+
Properties:
|
|
324
|
+
- `enabled: boolean`
|
|
325
|
+
- `messageBox: { lifespan: number }`
|
|
326
|
+
|
|
327
|
+
### ConsoleAppenderConfig
|
|
328
|
+
|
|
329
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
330
|
+
Extends: `LogAppenderConfig`
|
|
331
|
+
|
|
332
|
+
Description: console appender configuration
|
|
333
|
+
|
|
334
|
+
Properties:
|
|
335
|
+
- `prefixConverters?: ConsoleAppenderPrefixConverters` — pluggable custom prefix converters
|
|
336
|
+
- `prefixFormat?: string` — customizable prefix to be added to the log messages
|
|
337
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
338
|
+
|
|
339
|
+
### ConsoleAppenderTypeConfig
|
|
340
|
+
|
|
341
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
342
|
+
Extends: `ConsoleAppenderConfig`
|
|
343
|
+
|
|
344
|
+
Description: console appender configuration including also the type of the console appender
|
|
345
|
+
|
|
346
|
+
Properties:
|
|
347
|
+
- `type: Type<ConsoleAppender>` — the console appender type
|
|
348
|
+
- `prefixConverters?: ConsoleAppenderPrefixConverters` — pluggable custom prefix converters
|
|
349
|
+
- `prefixFormat?: string` — customizable prefix to be added to the log messages
|
|
350
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
351
|
+
|
|
352
|
+
### CoreState
|
|
353
|
+
|
|
354
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/core.state.ts`
|
|
355
|
+
|
|
356
|
+
Properties:
|
|
357
|
+
- `app?: AppState`
|
|
358
|
+
- `i18n?: I18nState`
|
|
359
|
+
- `locale?: LocaleState`
|
|
360
|
+
- `notifications?: NotificationsState`
|
|
361
|
+
- `user?: UserState`
|
|
362
|
+
|
|
363
|
+
### EnvDynamicConfig
|
|
364
|
+
|
|
365
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-env-config.ts`
|
|
366
|
+
|
|
367
|
+
Description: The EnvDynamicConfig is the dynamic configuration object for the EUI library that uses the dynamic configuration to update the configuration at runtime. The dynamic configuration can be fetched from a local path or a web service, can be merged or deep merged with the default configuration at runtime and can be awaited for a specific duration to resolve the request.
|
|
368
|
+
|
|
369
|
+
Properties:
|
|
370
|
+
- `configTimeout?: number` — Dynamic config will be awaiting 2000ms(default) to resolve the request, to change this duration you can use this parameter
|
|
371
|
+
- `deepMerge?: boolean` — If merge array is provided, the way of merging will be one-level merge as default. To have deep merge functionality, you have to define deepMerge:true
|
|
372
|
+
- `merge?: Array<string>` — Dynamic configuration overwrites to the config properties of EuiAppJsonConfig in the default configuration (global, modules, versions, \[key: string\]: any; ) To merge the data for specific config property/ies you can define them as array, e.g.\['modules','global'\] Note: When deepMerge:true is not provided, If there is common sub property for the merged object, dynamic fetched config will be overwriting it, otherwise It will be merged deeply.
|
|
373
|
+
- `uri: string` — uri which can be local path or webservice, should store/return json-config which implements EuiAppJsonConfig
|
|
374
|
+
|
|
375
|
+
### EuiAppHandlersConfig
|
|
376
|
+
|
|
377
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
378
|
+
|
|
379
|
+
Properties:
|
|
380
|
+
- `customHandler?: { }`
|
|
381
|
+
- `errorMappingHandler?: ErrorMappingHandler`
|
|
382
|
+
- `httpErrorHandler?: HttpErrorHandlerConfig`
|
|
383
|
+
- `log?: LogConfig`
|
|
384
|
+
|
|
385
|
+
### EuiAppJsonConfig
|
|
386
|
+
|
|
387
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
388
|
+
|
|
389
|
+
Properties:
|
|
390
|
+
- `global: GlobalConfig`
|
|
391
|
+
- `modules?: ModulesConfig`
|
|
392
|
+
- `versions?: VersionsConfig`
|
|
393
|
+
|
|
394
|
+
### EuiAuthConfig
|
|
395
|
+
|
|
396
|
+
File: `packages/base/src/lib/eui-models/eui-auth-config.model.ts`
|
|
397
|
+
|
|
398
|
+
Properties:
|
|
399
|
+
- `isLoggedIn?: boolean`
|
|
400
|
+
- `loginPageUrl?: string`
|
|
401
|
+
- `redirectUrl?: string`
|
|
402
|
+
|
|
403
|
+
### EuiConfig
|
|
404
|
+
|
|
405
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-config.ts`
|
|
406
|
+
|
|
407
|
+
Description: EuiConfig is the main configuration object for the EUI library. It is used to provide the configuration to the EUI library. The EUI library uses the configuration to initialize the services and components.
|
|
408
|
+
|
|
409
|
+
Properties:
|
|
410
|
+
- `appConfig: EuiAppConfig` — The appConfig contains the global configuration and the modules' configuration.
|
|
411
|
+
- `environment: EuiEnvConfig` — The environment contains the environment specific configuration.
|
|
412
|
+
|
|
413
|
+
### EuiEnvConfig
|
|
414
|
+
|
|
415
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-env-config.ts`
|
|
416
|
+
|
|
417
|
+
Description: The EuiEnvConfig is the environment specific configuration object for the EUI library.
|
|
418
|
+
|
|
419
|
+
Properties:
|
|
420
|
+
- `envAppHandlersConfig?: EuiAppHandlersConfig` — The envAppHandlersConfig contains the environment specific handlers' configuration.
|
|
421
|
+
- `envDynamicConfig?: EnvDynamicConfig` — The envDynamicConfig contains the environment specific dynamic configuration.
|
|
422
|
+
- `loadedEnvDynamicConfig?: EuiAppJsonConfig` — The loadedEnvDynamicConfig contains the loaded environment specific dynamic configuration.
|
|
423
|
+
|
|
424
|
+
### EuiGlobalConfig
|
|
425
|
+
|
|
426
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
427
|
+
|
|
428
|
+
Properties:
|
|
429
|
+
- `assetsBaseUrl?: string`
|
|
430
|
+
- `theme?: string`
|
|
431
|
+
|
|
432
|
+
### EuiGrowlMessage
|
|
433
|
+
|
|
434
|
+
File: `packages/base/src/lib/eui-models/eui-growl-message.model.ts`
|
|
435
|
+
|
|
436
|
+
Description: Is used to define the structure of objects used for handling messages or notifications in a user interface. It allows for flexibility by allowing additional custom properties while also providing a set of predefined properties like severity, summary, detail, life, and sticky for common message attributes.
|
|
437
|
+
|
|
438
|
+
Properties:
|
|
439
|
+
- `detail?: string`
|
|
440
|
+
- `dismissed?: boolean`
|
|
441
|
+
- `filled?: boolean`
|
|
442
|
+
- `life?: number`
|
|
443
|
+
- `severity?: "success" | "warning" | "info" | "danger" | string`
|
|
444
|
+
- `sticky?: boolean`
|
|
445
|
+
- `summary?: string`
|
|
446
|
+
- `timeout?: number` — The timeout property is used to define the time in milliseconds before the message is automatically removed from the user interface. This property is only used when the sticky property is set to false.
|
|
447
|
+
|
|
448
|
+
### EuiLanguage
|
|
449
|
+
|
|
450
|
+
File: `packages/base/src/lib/eui-models/eui-language/eui-language.model.ts`
|
|
451
|
+
|
|
452
|
+
Properties:
|
|
453
|
+
- `code: string` — the ISO language code e.g. en or fr
|
|
454
|
+
- `isRtl?: boolean` — languages with rght to left writing
|
|
455
|
+
- `label: string` — the label of the language translated in that language
|
|
456
|
+
|
|
457
|
+
### EuiMenuItem
|
|
458
|
+
|
|
459
|
+
File: `packages/base/src/lib/eui-models/eui-menu-item.model.ts`
|
|
460
|
+
|
|
461
|
+
Properties:
|
|
462
|
+
- `actionIcon?: { icon: string; color?: string; label?: string; action?: void }`
|
|
463
|
+
- `active?: boolean`
|
|
464
|
+
- `allowedRightId?: string`
|
|
465
|
+
- `allowedRightIds?: string[]`
|
|
466
|
+
- `category?: string`
|
|
467
|
+
- `children?: EuiMenuItem[]`
|
|
468
|
+
- `command?: function`
|
|
469
|
+
- `deniedRightId?: string`
|
|
470
|
+
- `deniedRightIds?: string[]`
|
|
471
|
+
- `disabled?: boolean`
|
|
472
|
+
- `e2eAttr?: string`
|
|
473
|
+
- `expanded?: boolean`
|
|
474
|
+
- `filtered?: boolean`
|
|
475
|
+
- `hasMarker?: boolean`
|
|
476
|
+
- `iconClass?: string`
|
|
477
|
+
- `iconLabel?: string`
|
|
478
|
+
- `iconSvgName?: string`
|
|
479
|
+
- `iconSvgUrl?: string`
|
|
480
|
+
- `iconTypeClass?: string`
|
|
481
|
+
- `id?: string`
|
|
482
|
+
- `initials?: string`
|
|
483
|
+
- `isMegaMenu?: boolean`
|
|
484
|
+
- `label?: string`
|
|
485
|
+
- `link?: boolean`
|
|
486
|
+
- `markerTypeClass?: string`
|
|
487
|
+
- `megaMenuColIndex?: number`
|
|
488
|
+
- `megaMenuColLabel?: string`
|
|
489
|
+
- `metadata?: METADATA`
|
|
490
|
+
- `parent?: EuiMenuItem`
|
|
491
|
+
- `queryParams?: any`
|
|
492
|
+
- `tagLabel?: string`
|
|
493
|
+
- `tagTypeClass?: string`
|
|
494
|
+
- `tooltip?: string`
|
|
495
|
+
- `url?: string`
|
|
496
|
+
- `urlExternal?: string`
|
|
497
|
+
- `urlExternalTarget?: string`
|
|
498
|
+
- `visible?: boolean`
|
|
499
|
+
|
|
500
|
+
### EuiPaginationConfig
|
|
501
|
+
|
|
502
|
+
File: `packages/base/src/lib/eui-models/eui-pagination/eui-pagination.model.ts`
|
|
503
|
+
|
|
504
|
+
Properties:
|
|
505
|
+
- `currentPage?: number`
|
|
506
|
+
- `pageSize?: number`
|
|
507
|
+
- `pageWindowSize?: number`
|
|
508
|
+
- `totalItems?: number`
|
|
509
|
+
|
|
510
|
+
### EuiServiceModel
|
|
511
|
+
|
|
512
|
+
File: `packages/base/src/lib/eui-models/eui-service.model.ts`
|
|
513
|
+
|
|
514
|
+
Methods:
|
|
515
|
+
- `getState(): Observable<T>` — retrieves the State of the service. If you don't pass anything it will retrieve the whole State of that service. If you pass a selector or MapFunction it will retrieve a slice of the state. If you pass a string that's a key of the Service State type it will retrieve that slice of the state.
|
|
516
|
+
- `getState(mapFn: function): Observable<K>`
|
|
517
|
+
- `getState(key: A): Observable<T['A']>`
|
|
518
|
+
- `getState(keyOrMapFn?: unknown | string): Observable<K>`
|
|
519
|
+
- `init(t: T): Observable<EuiServiceStatus>`
|
|
520
|
+
- `updateState(t: T): void`
|
|
521
|
+
|
|
522
|
+
### EuiServiceStatus
|
|
523
|
+
|
|
524
|
+
File: `packages/base/src/lib/eui-models/eui-service.model.ts`
|
|
525
|
+
|
|
526
|
+
Description: EuiServiceStatus is a model that represents the status of the service. It has a boolean property that indicates whether the service was successful or not. If the service was not successful it will have an error property that contains the error message. success a boolean property that indicates whether the service was successful or not error an optional property that contains the error message
|
|
527
|
+
|
|
528
|
+
Properties:
|
|
529
|
+
- `error?: T`
|
|
530
|
+
- `success: boolean`
|
|
531
|
+
|
|
532
|
+
### EuiStoreServiceModel
|
|
533
|
+
|
|
534
|
+
File: `packages/base/src/lib/eui-models/eui-store/eui-store-service.model.ts`
|
|
535
|
+
|
|
536
|
+
Methods:
|
|
537
|
+
- `select(mapFn: function): Observable<K | Partial>`
|
|
538
|
+
|
|
539
|
+
### EuiUserRight
|
|
540
|
+
|
|
541
|
+
File: `packages/base/src/lib/eui-models/eui-permission.model.ts`
|
|
542
|
+
|
|
543
|
+
Properties:
|
|
544
|
+
- `id: string`
|
|
545
|
+
- `permissions?: string[]`
|
|
546
|
+
|
|
547
|
+
### GlobalConfig
|
|
548
|
+
|
|
549
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
550
|
+
|
|
551
|
+
Properties:
|
|
552
|
+
- `eui?: EuiGlobalConfig`
|
|
553
|
+
- `i18n?: I18nConfig`
|
|
554
|
+
- `locale?: LocaleServiceConfig`
|
|
555
|
+
- `showConnectionStatus?: ConnectionStatus` — show/hide connection status
|
|
556
|
+
- `user?: UserConfig`
|
|
557
|
+
|
|
558
|
+
### HttpErrorHandlerConfig
|
|
559
|
+
|
|
560
|
+
File: `packages/base/src/lib/eui-models/eui-config/http-error-handler.config.ts`
|
|
561
|
+
|
|
562
|
+
Properties:
|
|
563
|
+
- `routes: HttpErrorRouteConfig[]` — The list of routes, from specific to generic. The first matching one is handled.
|
|
564
|
+
|
|
565
|
+
### HttpErrorRouteConfig
|
|
566
|
+
|
|
567
|
+
File: `packages/base/src/lib/eui-models/eui-config/http-error-handler.config.ts`
|
|
568
|
+
|
|
569
|
+
Properties:
|
|
570
|
+
- `default?: HttpErrorCallbackFn | string | null` — Default behaviour, if error status code does not match
|
|
571
|
+
- `path: string` — The path to match against, a URL string that uses router matching notation. Can include wildcard characters (\*).
|
|
572
|
+
|
|
573
|
+
### I18nConfig
|
|
574
|
+
|
|
575
|
+
File: `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
576
|
+
|
|
577
|
+
Properties:
|
|
578
|
+
- `i18nLoader: I18nLoaderConfig`
|
|
579
|
+
- `i18nService: I18nServiceConfig`
|
|
580
|
+
- `icuEnabled?: boolean`
|
|
581
|
+
|
|
582
|
+
### I18nLoaderConfig
|
|
583
|
+
|
|
584
|
+
File: `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
585
|
+
|
|
586
|
+
Properties:
|
|
587
|
+
- `i18nFolders?: string | string[]` — Those folders will be used to load the translations files from https://angular.io/guide/workspace-config#extra-build-and-test-options assets. e.g \[ ${environment.apiBaseUrl}translations/ , ${environment.apiBaseUrl}translations?lang= \] Important! the language code will be added automatically to the end of the url except if the url ends with a slash.
|
|
588
|
+
- `i18nResources?: I18nResource | I18nResource[]` — It is a set of more customized resources to be loaded. You can provide a function to compile the translations or simply provide the prefix and suffix of the resource, or both. Example : export function CompileTranslations(translations: any): any { const result = {}; translations.forEach((translation: any) =\> { // extract the key and value from the translation object const key = translation\['key'\]; const value = translation\['value'\]; if (key && value) { result\[key\] = value; } }); return result; } export const appConfig: EuiAppConfig = { ..., customHandler: { 'CompileTranslations\_ID': CompileTranslations } }; export const GLOBAL: GlobalConfig = { ..., i18n: { i18nLoader: { i18nFolders: \['i18n-eui'\], i18nResources: \[{ prefix: 'api/translations/', compileTranslations: 'CompileTranslations\_ID', }\] } } }; \_\_\_COMPODOC\_EMPTY\_LINE\_\_\_ \_\_\_COMPODOC\_EMPTY\_LINE\_\_\_
|
|
589
|
+
- `i18nServices?: string | string[]` — Array of service urls to translation, don't add the language it will be added e.g. http://net1/trans/en Keep in mind that the url should be the prefix and not contain any suffix.
|
|
590
|
+
|
|
591
|
+
### I18nResource
|
|
592
|
+
|
|
593
|
+
File: `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
594
|
+
|
|
595
|
+
Properties:
|
|
596
|
+
- `compileTranslations?: string` — It is an ID of the function which should be defined into the customHandlers with the interface TranslationsCompiler
|
|
597
|
+
- `prefix: string` — prefix of the resource could be like the 2 char language code e.g. /en
|
|
598
|
+
- `suffix?: string` — suffix can be either .json or anything related of the resource HTTP call
|
|
599
|
+
|
|
600
|
+
### I18nServiceConfig
|
|
601
|
+
|
|
602
|
+
File: `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
603
|
+
|
|
604
|
+
Properties:
|
|
605
|
+
- `defaultLanguage?: string` — default language to be used in case of not any has been set
|
|
606
|
+
- `languages?: (string | EuiLanguage)[]` — an ISO 2 char code array of available languages
|
|
607
|
+
|
|
608
|
+
### I18nState
|
|
609
|
+
|
|
610
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/i18n.state.ts`
|
|
611
|
+
|
|
612
|
+
Properties:
|
|
613
|
+
- `activeLang: string`
|
|
614
|
+
|
|
615
|
+
### LoadedConfigModules
|
|
616
|
+
|
|
617
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/app.state.ts`
|
|
618
|
+
|
|
619
|
+
Description: LoadedConfigModules lastAddedModule - the last module added to the store modulesConfig - the modules configuration
|
|
620
|
+
|
|
621
|
+
Properties:
|
|
622
|
+
- `lastAddedModule?: string`
|
|
623
|
+
- `modulesConfig: ModulesConfig`
|
|
624
|
+
|
|
625
|
+
### LocaleServiceConfig
|
|
626
|
+
|
|
627
|
+
File: `packages/base/src/lib/eui-models/eui-config/locale.config.ts`
|
|
628
|
+
|
|
629
|
+
Properties:
|
|
630
|
+
- `bindWithTranslate?: boolean` — When enabled changes from I18nService will be reflected to locale state
|
|
631
|
+
|
|
632
|
+
### LocaleState
|
|
633
|
+
|
|
634
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/locale.state.ts`
|
|
635
|
+
|
|
636
|
+
Description: The locale state is used to store the current locale id and the list of available locales.
|
|
637
|
+
|
|
638
|
+
Properties:
|
|
639
|
+
- `id: string` — The current locale id e.g. 'en-US'
|
|
640
|
+
|
|
641
|
+
### LogAppenderConfig
|
|
642
|
+
|
|
643
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
644
|
+
|
|
645
|
+
Properties:
|
|
646
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
647
|
+
|
|
648
|
+
### LogAppenderTypeConfig
|
|
649
|
+
|
|
650
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
651
|
+
Extends: `LogAppenderConfig`
|
|
652
|
+
|
|
653
|
+
Description: log appender configuration including also the type of the appender
|
|
654
|
+
|
|
655
|
+
Properties:
|
|
656
|
+
- `type: Type<LogAppender>` — the log appender type
|
|
657
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
658
|
+
|
|
659
|
+
### LogConfig
|
|
660
|
+
|
|
661
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
662
|
+
|
|
663
|
+
Description: log configuration
|
|
664
|
+
|
|
665
|
+
Properties:
|
|
666
|
+
- `baseLoggerName?: string` — the name of the default logger, if LogService is used directly. Default: root
|
|
667
|
+
- `logAppenders?: LogAppenderType | LogAppenderType[]` — a list of log appenders' types. Default: ConsoleAppender with prefixFormat: '\[{level}\]'
|
|
668
|
+
- `logLevel?: LogLevel` — log level. Default: LogLevel.ERROR
|
|
669
|
+
|
|
670
|
+
### LogEvent
|
|
671
|
+
|
|
672
|
+
File: `packages/base/src/lib/eui-models/log/log.model.ts`
|
|
673
|
+
|
|
674
|
+
Description: The log event sent to the log appenders
|
|
675
|
+
|
|
676
|
+
Properties:
|
|
677
|
+
- `level: LogLevel` — event's log level
|
|
678
|
+
- `levelName: string` — event's log level name
|
|
679
|
+
- `loggerName: string` — the name of the logger who triggered the event
|
|
680
|
+
- `messages: MESSAGES[]` — log messages
|
|
681
|
+
- `timestamp: Date` — event's timestamp
|
|
682
|
+
|
|
683
|
+
### LogPosition
|
|
684
|
+
|
|
685
|
+
File: `packages/base/src/lib/eui-models/log/log.model.ts`
|
|
686
|
+
|
|
687
|
+
Description: The code position from where the log has been triggered
|
|
688
|
+
|
|
689
|
+
Properties:
|
|
690
|
+
- `column: number`
|
|
691
|
+
- `file: string`
|
|
692
|
+
- `line: number`
|
|
693
|
+
|
|
694
|
+
### ModuleConfig
|
|
695
|
+
|
|
696
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
697
|
+
Extends: `LogConfig`, `I18nLoaderConfig`
|
|
698
|
+
|
|
699
|
+
Properties:
|
|
700
|
+
- `baseLoggerName?: string` — the name of the default logger, if LogService is used directly. Default: root
|
|
701
|
+
- `logAppenders?: LogAppenderType | LogAppenderType[]` — a list of log appenders' types. Default: ConsoleAppender with prefixFormat: '\[{level}\]'
|
|
702
|
+
- `logLevel?: LogLevel` — log level. Default: LogLevel.ERROR
|
|
703
|
+
|
|
704
|
+
### ModulesConfig
|
|
705
|
+
|
|
706
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
707
|
+
|
|
708
|
+
### NotificationsState
|
|
709
|
+
|
|
710
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/notifications.state.ts`
|
|
711
|
+
|
|
712
|
+
Description: The notifications state.
|
|
713
|
+
|
|
714
|
+
Properties:
|
|
715
|
+
- `list?: LIST[]`
|
|
716
|
+
|
|
717
|
+
### UrlAppenderConfig
|
|
718
|
+
|
|
719
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
720
|
+
Extends: `LogAppenderConfig`
|
|
721
|
+
|
|
722
|
+
Description: url appender configuration
|
|
723
|
+
|
|
724
|
+
Properties:
|
|
725
|
+
- `detailedEventFromLevel?: LogLevel` — extended log event triggered after the mentioned level. If missing, the extended log level is not triggered
|
|
726
|
+
- `url: string` — url to POST the log event to a server
|
|
727
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
728
|
+
|
|
729
|
+
### UrlAppenderTypeConfig
|
|
730
|
+
|
|
731
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
732
|
+
Extends: `UrlAppenderConfig`
|
|
733
|
+
|
|
734
|
+
Description: url appender configuration including also the type of the url appender
|
|
735
|
+
|
|
736
|
+
Properties:
|
|
737
|
+
- `type: Type<UrlAppender>` — the url appender type
|
|
738
|
+
- `detailedEventFromLevel?: LogLevel` — extended log event triggered after the mentioned level. If missing, the extended log level is not triggered
|
|
739
|
+
- `url: string` — url to POST the log event to a server
|
|
740
|
+
- `logLevel?: LogLevel` — appender log level. It overrides the main log level
|
|
741
|
+
|
|
742
|
+
### UrlLogEvent
|
|
743
|
+
|
|
744
|
+
File: `packages/base/src/lib/eui-models/eui-config/log.config.ts`
|
|
745
|
+
Extends: `LogEvent`
|
|
746
|
+
|
|
747
|
+
Description: url log event
|
|
748
|
+
|
|
749
|
+
Properties:
|
|
750
|
+
- `location?: string` — the url of the current page
|
|
751
|
+
- `position?: LogPosition` — the code position from where the log has been triggered
|
|
752
|
+
- `level: LogLevel` — event's log level
|
|
753
|
+
- `levelName: string` — event's log level name
|
|
754
|
+
- `loggerName: string` — the name of the logger who triggered the event
|
|
755
|
+
- `messages: MESSAGES[]` — log messages
|
|
756
|
+
- `timestamp: Date` — event's timestamp
|
|
757
|
+
|
|
758
|
+
### UserConfig
|
|
759
|
+
|
|
760
|
+
File: `packages/base/src/lib/eui-models/eui-config/user.config.ts`
|
|
761
|
+
|
|
762
|
+
Properties:
|
|
763
|
+
- `defaultUserPreferences?: UserPreferences`
|
|
764
|
+
|
|
765
|
+
### UserDetails
|
|
766
|
+
|
|
767
|
+
File: `packages/base/src/lib/eui-models/eui-store/models/user.models.ts`
|
|
768
|
+
|
|
769
|
+
Properties:
|
|
770
|
+
- `firstName?: string`
|
|
771
|
+
- `fullName?: string`
|
|
772
|
+
- `lastName?: string`
|
|
773
|
+
- `userId: string`
|
|
774
|
+
|
|
775
|
+
### UserPreferences
|
|
776
|
+
|
|
777
|
+
File: `packages/base/src/lib/eui-models/eui-store/models/user.models.ts`
|
|
778
|
+
|
|
779
|
+
Properties:
|
|
780
|
+
- `dashboard?: DASHBOARD`
|
|
781
|
+
- `lang?: string`
|
|
782
|
+
|
|
783
|
+
### UserState
|
|
784
|
+
|
|
785
|
+
File: `packages/base/src/lib/eui-models/eui-store/state/user.state.ts`
|
|
786
|
+
Extends: `UserDetails`
|
|
787
|
+
|
|
788
|
+
Properties:
|
|
789
|
+
- `firstName?: string`
|
|
790
|
+
- `fullName?: string`
|
|
791
|
+
- `lastName?: string`
|
|
792
|
+
- `preferences?: UserPreferences`
|
|
793
|
+
- `rights?: EuiUserRight[]`
|
|
794
|
+
- `userId: string`
|
|
795
|
+
|
|
796
|
+
### UxErrorFeedback
|
|
797
|
+
|
|
798
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
799
|
+
Extends: `UxErrorMessage`
|
|
800
|
+
|
|
801
|
+
Properties:
|
|
802
|
+
- `attributes?: UxValidationErrorAttributes`
|
|
803
|
+
- `br?: string`
|
|
804
|
+
- `doc?: string`
|
|
805
|
+
- `errGroupId?: string`
|
|
806
|
+
- `severity?: UxMessageSeverity`
|
|
807
|
+
- `description?: string`
|
|
808
|
+
- `msgId: string`
|
|
809
|
+
|
|
810
|
+
### UxErrorFollowMap
|
|
811
|
+
|
|
812
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
813
|
+
|
|
814
|
+
### UxErrorInfo
|
|
815
|
+
|
|
816
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
817
|
+
|
|
818
|
+
Properties:
|
|
819
|
+
- `code?: string`
|
|
820
|
+
- `details?: DETAILS`
|
|
821
|
+
- `doc?: string`
|
|
822
|
+
|
|
823
|
+
### UxErrorMessage
|
|
824
|
+
|
|
825
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
826
|
+
|
|
827
|
+
Properties:
|
|
828
|
+
- `description?: string`
|
|
829
|
+
- `msgId: string`
|
|
830
|
+
|
|
831
|
+
### UxFormValidationError
|
|
832
|
+
|
|
833
|
+
File: `packages/base/src/lib/ux-models/ux-validation-error.model.ts`
|
|
834
|
+
|
|
835
|
+
Properties:
|
|
836
|
+
- `uxValidationError: UxValidationErrorFeedback`
|
|
837
|
+
|
|
838
|
+
### UxHttpErrorInfo
|
|
839
|
+
|
|
840
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
841
|
+
|
|
842
|
+
Properties:
|
|
843
|
+
- `requestId?: string`
|
|
844
|
+
|
|
845
|
+
### UxHttpErrorResponse
|
|
846
|
+
|
|
847
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
848
|
+
Extends: `HttpErrorResponse`
|
|
849
|
+
|
|
850
|
+
Properties:
|
|
851
|
+
- `uxHttpErrorOutput: UxErrorOutput`
|
|
852
|
+
|
|
853
|
+
### UxModalLegacy
|
|
854
|
+
|
|
855
|
+
File: `packages/base/src/lib/ux-models/ux-modal-legacy.model.ts`
|
|
856
|
+
|
|
857
|
+
Properties:
|
|
858
|
+
- `id: string`
|
|
859
|
+
- `isFullHeight?: boolean`
|
|
860
|
+
- `isOpen: boolean`
|
|
861
|
+
|
|
862
|
+
### UxValidationErrorAttribute
|
|
863
|
+
|
|
864
|
+
File: `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|
|
865
|
+
|
|
866
|
+
Properties:
|
|
867
|
+
- `key: string | Array<string>`
|
|
868
|
+
- `value: string`
|
|
869
|
+
|
|
870
|
+
### UxValidationErrorFeedback
|
|
871
|
+
|
|
872
|
+
File: `packages/base/src/lib/ux-models/ux-validation-error.model.ts`
|
|
873
|
+
|
|
874
|
+
Properties:
|
|
875
|
+
- `message: string | UxValidationErrorI18nMessage`
|
|
876
|
+
- `type: string` — danger, warning, info
|
|
877
|
+
|
|
878
|
+
### UxValidationErrorI18nMessage
|
|
879
|
+
|
|
880
|
+
File: `packages/base/src/lib/ux-models/ux-validation-error.model.ts`
|
|
881
|
+
|
|
882
|
+
Properties:
|
|
883
|
+
- `id: string`
|
|
884
|
+
- `params?: object`
|
|
885
|
+
|
|
886
|
+
### VersionsConfig
|
|
887
|
+
|
|
888
|
+
File: `packages/base/src/lib/eui-models/eui-config/eui-app-config.ts`
|
|
889
|
+
|
|
890
|
+
Properties:
|
|
891
|
+
- `app?: string`
|
|
892
|
+
|
|
893
|
+
### XHRConfig
|
|
894
|
+
|
|
895
|
+
File: `packages/base/src/lib/util/xhr.ts`
|
|
896
|
+
|
|
897
|
+
Description: XMLHttpRequest configuration having the following parameters url: the path to the request, mandatory method: possible http methods: GET, POST, PUT, PATCH, DELETE, etc responseType: arraybuffer, blob, document, json, text or empty string headers: object containing headers as name: value pairs body: request body withCredentials: True when credentials are to be included in a cross-origin request. False otherwise. timeout - time in milliseconds. A non-zero value will terminate the execution after the given time has passed
|
|
898
|
+
|
|
899
|
+
Properties:
|
|
900
|
+
- `body?: Document | XMLHttpRequestBodyInit`
|
|
901
|
+
- `headers?: { }`
|
|
902
|
+
- `method?: string`
|
|
903
|
+
- `responseType?: XMLHttpRequestResponseType`
|
|
904
|
+
- `timeout?: number`
|
|
905
|
+
- `url: string`
|
|
906
|
+
- `withCredentials?: boolean`
|
|
907
|
+
|
|
908
|
+
## Public functions
|
|
909
|
+
|
|
910
|
+
- `merge(target: T): T`
|
|
911
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
912
|
+
- `merge(target: T, a: A): T & A`
|
|
913
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
914
|
+
- `merge(target: T, a: A, b: B): T & A & B`
|
|
915
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
916
|
+
- `merge(target: T, a: A, b: B, c: C): T & A & B & C`
|
|
917
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
918
|
+
- `merge(target: T, a: A, b: B, c: C, d: D): T & A & B & C & D`
|
|
919
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
920
|
+
- `merge(target: T, a: A, b: B, c: C, d: D, e: E): T & A & B & C & D & E`
|
|
921
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
922
|
+
- `merge(target: T, a: A, b: B, c: C, d: D, e: E, f: F): T & A & B & C & D & E & F`
|
|
923
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
924
|
+
- `merge(target: any, ...sources): any`
|
|
925
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
926
|
+
- `xhr(urlOrConfig): Promise<T>` — Utility function to call a XMLHttpRequest and send the response as a Promise. The response can be parameterized
|
|
927
|
+
Defined in `packages/base/src/lib/util/xhr.ts`
|
|
928
|
+
- `xhr(urlOrConfig): Promise<any>`
|
|
929
|
+
Defined in `packages/base/src/lib/util/xhr.ts`
|
|
930
|
+
|
|
931
|
+
## Public type aliases
|
|
932
|
+
|
|
933
|
+
- `type ConsoleAppenderPrefixConverters = { }` — The type of pluggable console prefix converters
|
|
934
|
+
- `type DeepPartial = unknown`
|
|
935
|
+
- `type ErrorMappingHandler = function`
|
|
936
|
+
- `type EuiAppConfig = EuiAppJsonConfig & EuiAppHandlersConfig`
|
|
937
|
+
- `type EuiLanguageCode = string | EuiLanguage`
|
|
938
|
+
- `type HttpErrorCallbackFn = function`
|
|
939
|
+
- `type HTTPMethod = "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE" | "PATCH"`
|
|
940
|
+
- `type LogAppenderType = Type<LogAppender> | LogAppenderTypeConfig | ConsoleAppenderTypeConfig | UrlAppenderTypeConfig` — log appender type, containing also the configuration of the specified appender
|
|
941
|
+
- `type SubErrors = Array<UxValidationErrorClass>`
|
|
942
|
+
- `type TranslationsCompiler = function` — a factory to compile translations into the main object holding them all
|
|
943
|
+
- `` type UUID = `${string}-${string}-${string}-${string}-${string}` `` — polyfill for usage of crypto.randomUUID() on non HTTPS environments EUI-10272 Please remove in the future when EC Policy for HTTPS is enforced.
|
|
944
|
+
- `type UxErrorFeedbackEventType = UxPublishErrorFeedbackEvent | UxClearErrorFeedbackEvent`
|
|
945
|
+
- `type UxErrorGroupItem = { groupId: string; description: string; severity: UxMessageSeverity; errors: Array<UxErrorFeedback> }`
|
|
946
|
+
- `type UxErrorGroupMap = { id: string; description: string; severity: UxMessageSeverity }`
|
|
947
|
+
- `type UxValidationErrorAttributes = Array<UxValidationErrorAttribute>`
|
|
948
|
+
|
|
949
|
+
## Public enumerations
|
|
950
|
+
|
|
951
|
+
- `enum LogLevel` — Log level
|
|
952
|
+
- `OFF`
|
|
953
|
+
- `FATAL = 1`
|
|
954
|
+
- `ERROR = 2`
|
|
955
|
+
- `WARN = 3`
|
|
956
|
+
- `INFO = 4`
|
|
957
|
+
- `DEBUG = 5`
|
|
958
|
+
- `TRACE = 6`
|
|
959
|
+
- `ALL = 7`
|
|
960
|
+
|
|
961
|
+
- `enum LogLevelName` — Associated log level names
|
|
962
|
+
- `FATAL = FATAL`
|
|
963
|
+
- `ERROR = ERROR`
|
|
964
|
+
- `WARN = WARNING`
|
|
965
|
+
- `INFO = INFO`
|
|
966
|
+
- `DEBUG = DEBUG`
|
|
967
|
+
- `TRACE = TRACE`
|
|
968
|
+
|
|
969
|
+
- `enum UxMessageSeverity`
|
|
970
|
+
- `info = info`
|
|
971
|
+
- `warning = warning`
|
|
972
|
+
- `danger = danger`
|
|
973
|
+
- `success = success`
|
|
974
|
+
|
|
975
|
+
- `enum UxMessageSeverityMetrics`
|
|
976
|
+
- `info`
|
|
977
|
+
- `warning = 1`
|
|
978
|
+
- `danger = 2`
|
|
979
|
+
- `success = 3`
|
|
980
|
+
|
|
981
|
+
## Public variables
|
|
982
|
+
|
|
983
|
+
- `DEFAULT_CONSOLE_APPENDER_PREFIX_CONVERTERS: ConsoleAppenderPrefixConverters = { '{level}': (event: LogEvent) => event.levelName, '{logger}': (event: LogEvent) => event.loggerName, '{date}': (event: LogEvent) => event.timestamp.toLocaleDat…` — Default console prefix converters
|
|
984
|
+
Defined in `packages/base/src/lib/eui-models/log/console.appender.ts`
|
|
985
|
+
- `DEFAULT_XHR_CONFIG: XHRConfig = { url: null, method: 'GET', responseType: 'json', headers: {}, body: null, withCredentials: false, timeout: 0, }` — Default xhr configuration
|
|
986
|
+
Defined in `packages/base/src/lib/util/xhr.ts`
|
|
987
|
+
- `DefaultConfig: EuiPaginationConfig = { totalItems: 0, pageSize: 10, currentPage: 1, pageWindowSize: 5, }`
|
|
988
|
+
Defined in `packages/base/src/lib/eui-models/eui-pagination/eui-pagination.model.ts`
|
|
989
|
+
- `EUI_COLORS: object = { text: '#333333', default: '#333333', black: '#000000', white: '#ffffff', primary: '#004494', primaryDark: '#003e8c', primaryDarker: '#003581', primaryDarkest:…`
|
|
990
|
+
Defined in `packages/base/src/lib/eui-models/eui-constants.ts`
|
|
991
|
+
- `EUI_DEFAULT_AUTH_CONFIG: EuiAuthConfig = { isLoggedIn: true, redirectUrl: '', loginPageUrl: '', }`
|
|
992
|
+
Defined in `packages/base/src/lib/eui-models/eui-auth-config.model.ts`
|
|
993
|
+
- `getActiveLang: Selector<CoreState, string> = createSelector(getI18nState, (state: I18nState) => state.activeLang)`
|
|
994
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/i18n.selectors.ts`
|
|
995
|
+
- `getApiQueue: Selector<AppState, ApiQueue> = createSelector(getAppState, (state: AppState) => state.apiQueue)`
|
|
996
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
997
|
+
- `getApiQueueItem: unknown = (itemId: string): Selector<AppState, ApiQueueItem> => createSelector(getAppState, (state: AppState) => state.apiQueue[itemId])`
|
|
998
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
999
|
+
- `getAppConnection: Selector<AppState, boolean> = createSelector(getAppState, (state: AppState) => state.connected)`
|
|
1000
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1001
|
+
- `getAppLoadedConfigModules: Selector<CoreState, LoadedConfigModules> = (state: CoreState) => state?.app?.loadedConfigModules`
|
|
1002
|
+
Defined in `packages/base/src/lib/eui-models/eui-service.model.ts`
|
|
1003
|
+
- `getAppLoadedConfigModules: Selector<AppState, LoadedConfigModules> = createSelector( getAppState, (state: AppState) => state.loadedConfigModules, )` (deprecated: It will be removed in the future.) — Returns the loaded config modules from the app state
|
|
1004
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1005
|
+
- `getAppState: unknown = (state: CoreState): AppState => state.app`
|
|
1006
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/core.selectors.ts`
|
|
1007
|
+
- `getAppStatus: Selector<AppState, string> = createSelector(getAppState, (state: AppState) => state.status)`
|
|
1008
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1009
|
+
- `getAppVersion: Selector<AppState, string> = createSelector(getAppState, (state: AppState) => state.version)`
|
|
1010
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1011
|
+
- `getBrowserDefaultLanguage: unknown = (): string => navigator.language.split('-')[0]` — returns a language code based on https://tools.ietf.org/rfc/bcp/bcp47.txt specification. To get the Browser's it's using the navigator.language, splits by hyphen and get the first part.
|
|
1012
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
1013
|
+
- `getBrowserPreferredLanguages: unknown = (): string[] => navigator.languages.map((lang) => lang.split('-')[0])` — returns an array of DOMStrings representing the user's preferred languages. The language is described using BCP 47 language tags. In the returned array they are ordered by preference with the most preferred language first. The array languages will be lower cased 2 char code.
|
|
1014
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
1015
|
+
- `getCurrentModule: Selector<AppState, string> = createSelector(getAppState, (state: AppState) => state.currentModule)`
|
|
1016
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1017
|
+
- `getI18nLoaderConfig: unknown = (config: I18nLoaderConfig): I18nLoaderConfig => { const { i18nFolders, i18nServices, i18nResources } = Object.assign({}, config); return { i18nFolders, i18nServ…`
|
|
1018
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
1019
|
+
- `getI18nServiceConfig: unknown = (config: I18nServiceConfig): I18nServiceConfig => Object.assign({}, config)`
|
|
1020
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
1021
|
+
- `getI18nServiceConfigFromBase: unknown = (baseGlobalConfig: GlobalConfig): I18nServiceConfig => { if(!baseGlobalConfig) throw new Error('baseGlobalConfig is required'); const i18nServiceConfig = baseGl…`
|
|
1022
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/i18n.config.ts`
|
|
1023
|
+
- `getI18nState: unknown = (state: CoreState): I18nState => state.i18n`
|
|
1024
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/core.selectors.ts`
|
|
1025
|
+
- `getLastAddedModule: Selector<AppState, string> = createSelector( getAppState, (state: AppState) => state.loadedConfigModules.lastAddedModule, )` (deprecated: It will be removed in the future.) — Returns the last added module from the app state
|
|
1026
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/app.selectors.ts`
|
|
1027
|
+
- `getLocaleServiceConfigFromBase: unknown = (baseGlobalConfig: GlobalConfig): LocaleServiceConfig => { const { bindWithTranslate } = baseGlobalConfig.locale; return { bindWithTranslate }; }` — responsible to extract the attributes "available" and "id" from the locale configuration
|
|
1028
|
+
Defined in `packages/base/src/lib/eui-models/eui-config/locale.config.ts`
|
|
1029
|
+
- `getLocaleState: unknown = (state: CoreState): LocaleState => state.locale`
|
|
1030
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/core.selectors.ts`
|
|
1031
|
+
- `getNotificationsList: Selector<AppState, unknown[]> = createSelector( getNotificationsState, (state: NotificationsState) => state.list, )`
|
|
1032
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/notifications.selectors.ts`
|
|
1033
|
+
- `getNotificationsState: unknown = (state: CoreState): NotificationsState => state.notifications`
|
|
1034
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/core.selectors.ts`
|
|
1035
|
+
- `getUserDashboard: Selector<UserPreferences<unknown>, unknown> = createSelector( getUserPreferences, (state: UserPreferences) => state.dashboard, )`
|
|
1036
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1037
|
+
- `getUserDetails: Selector<CoreState, UserDetails> = createSelector(getUserState, (state: UserState) => state as UserDetails)`
|
|
1038
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1039
|
+
- `getUserFirstName: Selector<CoreState, string> = createSelector(getUserDetails, (state: UserDetails) => state.firstName)`
|
|
1040
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1041
|
+
- `getUserFullName: Selector<CoreState, string> = createSelector(getUserDetails, (state: UserDetails) => state.fullName)`
|
|
1042
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1043
|
+
- `getUserId: Selector<CoreState, string> = createSelector(getUserDetails, (state: UserDetails) => state.userId)`
|
|
1044
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1045
|
+
- `getUserLang: Selector<UserPreferences, string> = createSelector(getUserPreferences, (state: UserPreferences) => state.lang)`
|
|
1046
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1047
|
+
- `getUserLastName: Selector<CoreState, string> = createSelector(getUserDetails, (state: UserDetails) => state.lastName)`
|
|
1048
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1049
|
+
- `getUserPreferences: Selector<CoreState, UserPreferences> = createSelector( getUserState, (state: UserState) => state.preferences, )`
|
|
1050
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1051
|
+
- `getUserRight: unknown = (rightId: string): Selector<CoreState, EuiUserRight> => createSelector(getUserRights, (state: EuiUserRight[]) => state.find((right) => right && right.id === rig…`
|
|
1052
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1053
|
+
- `getUserRightPermissions: unknown = (rightId: string): Selector<CoreState, string[]> => createSelector(getUserRight(rightId), (state: EuiUserRight) => state && state.permissions)`
|
|
1054
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1055
|
+
- `getUserRights: Selector<CoreState, EuiUserRight[]> = createSelector(getUserState, (state: UserState) => state.rights)`
|
|
1056
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/user.selectors.ts`
|
|
1057
|
+
- `getUserState: unknown = (state: CoreState): UserState => state.user`
|
|
1058
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/selectors/core.selectors.ts`
|
|
1059
|
+
- `initialAppState: AppState = Object.assign( {}, { version: '0.0.0', connected: true, loadedConfigModules: { modulesConfig: {}, }, status: 'idle', currentModule: '', apiQueue: {}, }, )`
|
|
1060
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/app.state.ts`
|
|
1061
|
+
- `initialCoreState: CoreState = Object.assign( {}, { app: initialAppState, user: initialUserState, notifications: initialNotificationsState, i18n: initialI18nState, locale: initialLocaleState,…`
|
|
1062
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/core.state.ts`
|
|
1063
|
+
- `initialI18nState: I18nState = { activeLang: null, }`
|
|
1064
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/i18n.state.ts`
|
|
1065
|
+
- `initialLocaleState: LocaleState = { id: 'en', }` — The initial state of the locale state. The default locale is English US ('en').
|
|
1066
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/locale.state.ts`
|
|
1067
|
+
- `initialNotificationsState: NotificationsState = { list: [], }` — The initial state of the notifications state.
|
|
1068
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/notifications.state.ts`
|
|
1069
|
+
- `initialUserPreferences: UserPreferences = Object.assign( {}, { lang: null, dashboard: null, }, )`
|
|
1070
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/models/user.models.ts`
|
|
1071
|
+
- `initialUserState: UserState = Object.assign( {}, { userId: '', firstName: '', lastName: '', fullName: '', preferences: initialUserPreferences, rights: [], }, )`
|
|
1072
|
+
Defined in `packages/base/src/lib/eui-models/eui-store/state/user.state.ts`
|
|
1073
|
+
- `isObject: unknown = <T>(item: T): boolean => item && typeof item === 'object' && !Array.isArray(item)`
|
|
1074
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
1075
|
+
- `mergeAll: unknown = <T>(array: Array<T>): T => array.reduce((prev, next) => mergeDeep(prev, next), {})`
|
|
1076
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
1077
|
+
- `mergeDeep: unknown = <T extends object, S>(target: T, ...sources: S[]): any => { const output: object & T = Object.assign({}, target); if (!sources.length) { return output as T | T …` — deep merge of two or more objects
|
|
1078
|
+
Defined in `packages/base/src/lib/util/merge.ts`
|
|
1079
|
+
- `range: unknown = (start: number, end?: number, step = 1): Array<number> => { const output = []; if (typeof end === 'undefined') { end = start; start = 0; } for (let i = start; i…`
|
|
1080
|
+
Defined in `packages/base/src/lib/eui-models/eui-pagination/eui-pagination.model.ts`
|
|
1081
|
+
- `testBed: unknown = getTestBed()`
|
|
1082
|
+
Defined in `packages/base/test-setup.ts`
|
|
1083
|
+
- `transformToUxHttpResponse: unknown = (resp: HttpErrorResponse, mapper: ErrorMappingHandler): UxHttpErrorResponse => { const updatedErr = resp as UxHttpErrorResponse; updatedErr.uxHttpErrorOutput = …`
|
|
1084
|
+
Defined in `packages/base/src/lib/ux-models/ux-error-feedback.model.ts`
|