@eui/base 23.0.0-alpha.2 → 23.0.0-alpha.3

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.
Files changed (108) hide show
  1. package/docs/architecture.html +223 -0
  2. package/docs/changelog.html +87 -2
  3. package/docs/classes/ConsoleAppender.html +76 -27
  4. package/docs/classes/EuiEuLanguages.html +55 -16
  5. package/docs/classes/EuiLazyService.html +86 -25
  6. package/docs/classes/EuiPagination.html +69 -16
  7. package/docs/classes/EuiService.html +103 -28
  8. package/docs/classes/LogAppender.html +52 -20
  9. package/docs/classes/Logger.html +100 -30
  10. package/docs/classes/LoggerMock.html +92 -22
  11. package/docs/classes/UrlAppender.html +78 -24
  12. package/docs/classes/UxBadgeLegacy.html +47 -16
  13. package/docs/classes/UxClearErrorFeedbackEvent.html +47 -16
  14. package/docs/classes/UxErrorGroupOnClickEvent.html +47 -16
  15. package/docs/classes/UxErrorOutput.html +91 -24
  16. package/docs/classes/UxLinkLegacy.html +105 -31
  17. package/docs/classes/UxPublishErrorFeedbackEvent.html +49 -16
  18. package/docs/classes/UxValidationErrorClass.html +77 -18
  19. package/docs/dependencies.html +38 -4
  20. package/docs/index.html +26 -2
  21. package/docs/interfaces/ApiQueue.html +41 -11
  22. package/docs/interfaces/ApiQueueItem.html +209 -181
  23. package/docs/interfaces/AppState.html +312 -284
  24. package/docs/interfaces/ConnectionStatus.html +134 -93
  25. package/docs/interfaces/ConsoleAppenderConfig.html +206 -104
  26. package/docs/interfaces/ConsoleAppenderTypeConfig.html +253 -53
  27. package/docs/interfaces/CoreState.html +272 -244
  28. package/docs/interfaces/EnvDynamicConfig.html +218 -190
  29. package/docs/interfaces/EuiAppHandlersConfig.html +229 -201
  30. package/docs/interfaces/EuiAppJsonConfig.html +171 -143
  31. package/docs/interfaces/EuiAuthConfig.html +184 -156
  32. package/docs/interfaces/EuiConfig.html +131 -103
  33. package/docs/interfaces/EuiEnvConfig.html +180 -152
  34. package/docs/interfaces/EuiGlobalConfig.html +140 -112
  35. package/docs/interfaces/EuiGrowlMessage.html +408 -380
  36. package/docs/interfaces/EuiLanguage.html +169 -141
  37. package/docs/interfaces/EuiMenuItem.html +1708 -1653
  38. package/docs/interfaces/EuiPaginationConfig.html +228 -200
  39. package/docs/interfaces/EuiServiceModel.html +109 -67
  40. package/docs/interfaces/EuiServiceStatus.html +138 -108
  41. package/docs/interfaces/EuiStoreServiceModel.html +64 -36
  42. package/docs/interfaces/EuiUserRight.html +127 -99
  43. package/docs/interfaces/GlobalConfig.html +268 -240
  44. package/docs/interfaces/HttpErrorHandlerConfig.html +96 -68
  45. package/docs/interfaces/HttpErrorRouteConfig.html +136 -108
  46. package/docs/interfaces/I18nConfig.html +157 -129
  47. package/docs/interfaces/I18nLoaderConfig.html +199 -152
  48. package/docs/interfaces/I18nResource.html +176 -148
  49. package/docs/interfaces/I18nServiceConfig.html +141 -113
  50. package/docs/interfaces/I18nState.html +91 -63
  51. package/docs/interfaces/LoadedConfigModules.html +137 -107
  52. package/docs/interfaces/LocaleServiceConfig.html +102 -74
  53. package/docs/interfaces/LocaleState.html +96 -68
  54. package/docs/interfaces/LogAppenderConfig.html +123 -70
  55. package/docs/interfaces/LogAppenderTypeConfig.html +159 -61
  56. package/docs/interfaces/LogConfig.html +196 -149
  57. package/docs/interfaces/LogEvent.html +246 -199
  58. package/docs/interfaces/LogPosition.html +151 -123
  59. package/docs/interfaces/ModuleConfig.html +236 -12
  60. package/docs/interfaces/ModulesConfig.html +41 -11
  61. package/docs/interfaces/NotificationsState.html +98 -70
  62. package/docs/interfaces/UrlAppenderConfig.html +200 -98
  63. package/docs/interfaces/UrlAppenderTypeConfig.html +247 -53
  64. package/docs/interfaces/UrlLogEvent.html +368 -96
  65. package/docs/interfaces/UserConfig.html +97 -69
  66. package/docs/interfaces/UserDetails.html +237 -190
  67. package/docs/interfaces/UserPreferences.html +141 -113
  68. package/docs/interfaces/UserState.html +326 -279
  69. package/docs/interfaces/UxErrorFeedback.html +373 -235
  70. package/docs/interfaces/UxErrorFollowMap.html +41 -11
  71. package/docs/interfaces/UxErrorInfo.html +201 -151
  72. package/docs/interfaces/UxErrorMessage.html +149 -102
  73. package/docs/interfaces/UxFormValidationError.html +91 -63
  74. package/docs/interfaces/UxHttpErrorInfo.html +112 -65
  75. package/docs/interfaces/UxHttpErrorResponse.html +108 -61
  76. package/docs/interfaces/UxModalLegacy.html +164 -136
  77. package/docs/interfaces/UxValidationErrorAttribute.html +121 -93
  78. package/docs/interfaces/UxValidationErrorFeedback.html +126 -98
  79. package/docs/interfaces/UxValidationErrorI18nMessage.html +127 -99
  80. package/docs/interfaces/VersionsConfig.html +96 -68
  81. package/docs/interfaces/XHRConfig.html +346 -318
  82. package/docs/js/architecture-graph.js +288 -0
  83. package/docs/js/libs/bootstrap-native.js +4 -2
  84. package/docs/js/libs/tablesort.min.js +3 -3
  85. package/docs/js/libs/tablesort.number.min.js +2 -2
  86. package/docs/js/libs/vis-network.min.js +7 -7
  87. package/docs/js/menu-wc.js +30 -23
  88. package/docs/js/routes.js +138 -37
  89. package/docs/js/search/search.js +62 -0
  90. package/docs/js/search/search_index.js +2 -2
  91. package/docs/js/tabs.js +98 -15
  92. package/docs/js/tree.js +44 -7
  93. package/docs/json/documentation.json +3154 -482
  94. package/docs/license.html +26 -2
  95. package/docs/llms.txt +1084 -0
  96. package/docs/miscellaneous/enumerations.html +30 -6
  97. package/docs/miscellaneous/functions.html +138 -27
  98. package/docs/miscellaneous/typealiases.html +62 -29
  99. package/docs/miscellaneous/variables.html +77 -53
  100. package/docs/modules.html +26 -2
  101. package/docs/overview.html +26 -2
  102. package/docs/properties.html +27 -3
  103. package/docs/routes.html +26 -2
  104. package/docs/styles/compodoc.css +365 -44
  105. package/docs/styles/dark.css +16 -0
  106. package/docs/template-playground/hbs-render.service.ts +6 -1
  107. package/package.json +1 -1
  108. package/docs/js/menu-wc_es5.js +0 -40
@@ -85,7 +85,14 @@
85
85
  </div>
86
86
 
87
87
  <div class="xs-menu menu" id="mobile-menu">
88
- <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
88
+ <div id="book-search-input" role="search">
89
+ <input type="text" placeholder="Type to search">
90
+ <button type="button"
91
+ class="search-input-clear"
92
+ aria-label="Clear search"
93
+ data-search-input-clear>&times;</button>
94
+ </div>
95
+ <compodoc-menu></compodoc-menu>
89
96
  </div>
90
97
 
91
98
  <div class="container-fluid main">
@@ -120,6 +127,11 @@
120
127
  I18nLoaderConfig</li>
121
128
  </ol>
122
129
 
130
+ <div class="io-file io-file-path" data-compodoc="entity-file-path">
131
+ <span class="icon ion-ios-document" aria-hidden="true"></span>
132
+ <code>packages/base/src/lib/eui-models/eui-config/i18n.config.ts</code>
133
+ </div>
134
+
123
135
  <ul class="nav nav-tabs" role="tablist">
124
136
  <li class="nav-item">
125
137
  <a href="#info"
@@ -127,149 +139,166 @@
127
139
  class="nav-link active"
128
140
  role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
129
141
  </li>
142
+ <li class="nav-item">
143
+ <a href="#api"
144
+ class="nav-link"
145
+
146
+ role="tab" id="api-tab" data-bs-toggle="tab" data-link="api">API</a>
147
+ </li>
130
148
  </ul>
131
149
 
132
150
  <div class="tab-content">
133
151
  <div class="tab-pane fade active in" id="info">
134
- <p class="comment">
135
- <h3>File</h3>
136
- </p>
137
- <p class="comment">
138
- <code>packages/base/src/lib/eui-models/eui-config/i18n.config.ts</code>
139
- </p>
140
152
 
141
153
 
142
154
 
155
+ <section data-compodoc="block-relationships">
156
+ <h3>Relationships</h3>
143
157
 
144
- <section data-compodoc="block-index">
145
- <h3 id="index">Index</h3>
146
- <table class="table table-sm table-bordered index-table">
147
- <tbody>
148
- <tr>
149
- <td class="col-md-4">
150
- <h6><b>Properties</b></h6>
151
- </td>
152
- </tr>
153
- <tr>
154
- <td class="col-md-4">
155
- <ul class="index-list">
156
- <li>
157
- <span class="modifier">Optional</span>
158
- <a href="#i18nFolders"
159
- >
160
- i18nFolders
161
- </a>
162
- </li>
158
+ <div class="row pt-3">
159
+ <div class="col-sm-6">
160
+ <h4>Used by</h4>
161
+ <ul class="list-unstyled relationships-list">
163
162
  <li>
164
- <span class="modifier">Optional</span>
165
- <a href="#i18nResources"
166
- >
167
- i18nResources
168
- </a>
163
+ <code><a href="../interfaces/ModuleConfig.html" target="_self" >ModuleConfig</a></code>
169
164
  </li>
170
- <li>
171
- <span class="modifier">Optional</span>
172
- <a href="#i18nServices"
173
- >
174
- i18nServices
175
- </a>
176
- </li>
177
- </ul>
178
- </td>
179
- </tr>
180
- </tbody>
181
- </table>
165
+ </ul>
166
+ </div>
167
+
168
+ <div class="col-sm-6">
169
+ <h4>Depends on</h4>
170
+ <p class="comment"><i>No results matching.</i></p>
171
+ </div>
172
+ </div>
182
173
  </section>
174
+ </div>
183
175
 
184
-
185
-
186
- <section data-compodoc="block-properties">
187
- <h3 id="inputs">Properties</h3>
188
- <table class="table table-sm table-bordered">
189
- <tbody>
190
- <tr>
191
- <td class="col-md-4">
192
- <a name="i18nFolders"></a>
193
- <span class="name "><b>i18nFolders</b>
194
- <a href="#i18nFolders">
195
- <span class="icon ion-ios-link"></span>
196
- </a>
197
- </span>
198
- </td>
199
- </tr>
200
- <tr>
201
- <td class="col-md-4">
202
- <code>i18nFolders: <code>string | string[]</code>
176
+ <div class="tab-pane fade " id="api"><section data-compodoc="block-index">
177
+ <h3 id="index">Index</h3>
178
+ <table class="table table-sm table-bordered index-table">
179
+ <tbody>
180
+ <tr>
181
+ <td class="col-md-3">
182
+ <h6><b>Properties</b></h6>
183
+ </td>
184
+ <td class="col-md-9">
185
+ <ul class="index-list">
186
+ <li>
187
+ <span class="modifier">Optional</span>
188
+ <a href="#i18nFolders" class="reference-link ">
189
+ <span class="reference-badge reference-badge--property" aria-hidden="true">P</span><span class="reference-link-label">i18nFolders</span>
190
+ </a>
191
+ </li>
192
+ <li>
193
+ <span class="modifier">Optional</span>
194
+ <a href="#i18nResources" class="reference-link ">
195
+ <span class="reference-badge reference-badge--property" aria-hidden="true">P</span><span class="reference-link-label">i18nResources</span>
196
+ </a>
197
+ </li>
198
+ <li>
199
+ <span class="modifier">Optional</span>
200
+ <a href="#i18nServices" class="reference-link ">
201
+ <span class="reference-badge reference-badge--property" aria-hidden="true">P</span><span class="reference-link-label">i18nServices</span>
202
+ </a>
203
+ </li>
204
+ </ul>
205
+ </td>
206
+ </tr>
207
+ </tbody>
208
+ </table>
209
+ </section>
210
+
211
+
212
+
213
+ <section data-compodoc="block-properties">
214
+ <h3 id="inputs">Properties</h3>
215
+ <table class="table table-sm table-bordered">
216
+ <tbody>
217
+ <tr>
218
+ <td class="col-md-4">
219
+ <a name="i18nFolders"></a>
220
+ <span class="name "><b>i18nFolders</b>
221
+ <a href="#i18nFolders">
222
+ <span class="icon ion-ios-link"></span>
223
+ </a>
224
+ </span>
225
+ </td>
226
+ </tr>
227
+ <tr>
228
+ <td class="col-md-4">
229
+ <code>i18nFolders: <code>string | string[]</code>
203
230
  </code>
204
- </td>
205
- </tr>
231
+ </td>
232
+ </tr>
206
233
 
207
234
 
208
- <tr>
209
- <td class="col-md-4">
210
- <i>Type : </i> <code>string | string[]</code>
235
+ <tr>
236
+ <td class="col-md-4">
237
+ <i>Type : </i> <code>string | string[]</code>
211
238
 
212
- </td>
213
- </tr>
239
+ </td>
240
+ </tr>
214
241
 
215
- <tr>
216
- <td class="col-md-4">
217
- <i>Optional</i>
218
- </td>
219
- </tr>
220
242
 
243
+ <tr>
244
+ <td class="col-md-4">
245
+ <i>Optional</i>
246
+ </td>
247
+ </tr>
221
248
 
222
249
 
223
250
 
224
- <tr>
225
- <td class="col-md-4">
226
- <div class="io-description"><p>Those folders will be used to load the translations files from <a href="https://angular.io/guide/workspace-config#extra-build-and-test-options">assets</a>.
251
+
252
+ <tr>
253
+ <td class="col-md-4">
254
+ <div class="io-description"><p>Those folders will be used to load the translations files from <a href="https://angular.io/guide/workspace-config#extra-build-and-test-options">assets</a>.
227
255
  e.g [<code>${environment.apiBaseUrl}translations/</code>, <code>${environment.apiBaseUrl}translations?lang=</code>]
228
256
  Important! the language code will be added automatically to the end of the url except if the url ends with a slash.</p>
229
257
  </div>
230
- </td>
231
- </tr>
232
- </tbody>
233
- </table>
234
- <table class="table table-sm table-bordered">
235
- <tbody>
236
- <tr>
237
- <td class="col-md-4">
238
- <a name="i18nResources"></a>
239
- <span class="name "><b>i18nResources</b>
240
- <a href="#i18nResources">
241
- <span class="icon ion-ios-link"></span>
242
- </a>
243
- </span>
244
- </td>
245
- </tr>
246
- <tr>
247
- <td class="col-md-4">
248
- <code>i18nResources: <code><a href="../interfaces/I18nResource.html" target="_self" >I18nResource | I18nResource[]</a></code>
258
+ </td>
259
+ </tr>
260
+ </tbody>
261
+ </table>
262
+ <table class="table table-sm table-bordered">
263
+ <tbody>
264
+ <tr>
265
+ <td class="col-md-4">
266
+ <a name="i18nResources"></a>
267
+ <span class="name "><b>i18nResources</b>
268
+ <a href="#i18nResources">
269
+ <span class="icon ion-ios-link"></span>
270
+ </a>
271
+ </span>
272
+ </td>
273
+ </tr>
274
+ <tr>
275
+ <td class="col-md-4">
276
+ <code>i18nResources: <code><a href="../interfaces/I18nResource.html" target="_self" >I18nResource | I18nResource[]</a></code>
249
277
  </code>
250
- </td>
251
- </tr>
278
+ </td>
279
+ </tr>
252
280
 
253
281
 
254
- <tr>
255
- <td class="col-md-4">
256
- <i>Type : </i> <code><a href="../interfaces/I18nResource.html" target="_self" >I18nResource | I18nResource[]</a></code>
282
+ <tr>
283
+ <td class="col-md-4">
284
+ <i>Type : </i> <code><a href="../interfaces/I18nResource.html" target="_self" >I18nResource | I18nResource[]</a></code>
285
+
286
+ </td>
287
+ </tr>
257
288
 
258
- </td>
259
- </tr>
260
289
 
261
- <tr>
262
- <td class="col-md-4">
263
- <i>Optional</i>
264
- </td>
265
- </tr>
290
+ <tr>
291
+ <td class="col-md-4">
292
+ <i>Optional</i>
293
+ </td>
294
+ </tr>
266
295
 
267
296
 
268
297
 
269
298
 
270
- <tr>
271
- <td class="col-md-4">
272
- <div class="io-description"><p>It is a set of more customized resources to be loaded. You can provide a function to compile the translations or simply
299
+ <tr>
300
+ <td class="col-md-4">
301
+ <div class="io-description"><p>It is a set of more customized resources to be loaded. You can provide a function to compile the translations or simply
273
302
  provide the prefix and suffix of the resource, or both.</p>
274
303
  <b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">export function CompileTranslations(translations: any): any {
275
304
  const result = {};
@@ -305,57 +334,58 @@ export const GLOBAL: GlobalConfig = {
305
334
 
306
335
 
307
336
  </code></pre></div></div>
308
- </td>
309
- </tr>
310
- </tbody>
311
- </table>
312
- <table class="table table-sm table-bordered">
313
- <tbody>
314
- <tr>
315
- <td class="col-md-4">
316
- <a name="i18nServices"></a>
317
- <span class="name "><b>i18nServices</b>
318
- <a href="#i18nServices">
319
- <span class="icon ion-ios-link"></span>
320
- </a>
321
- </span>
322
- </td>
323
- </tr>
324
- <tr>
325
- <td class="col-md-4">
326
- <code>i18nServices: <code>string | string[]</code>
337
+ </td>
338
+ </tr>
339
+ </tbody>
340
+ </table>
341
+ <table class="table table-sm table-bordered">
342
+ <tbody>
343
+ <tr>
344
+ <td class="col-md-4">
345
+ <a name="i18nServices"></a>
346
+ <span class="name "><b>i18nServices</b>
347
+ <a href="#i18nServices">
348
+ <span class="icon ion-ios-link"></span>
349
+ </a>
350
+ </span>
351
+ </td>
352
+ </tr>
353
+ <tr>
354
+ <td class="col-md-4">
355
+ <code>i18nServices: <code>string | string[]</code>
327
356
  </code>
328
- </td>
329
- </tr>
357
+ </td>
358
+ </tr>
330
359
 
331
360
 
332
- <tr>
333
- <td class="col-md-4">
334
- <i>Type : </i> <code>string | string[]</code>
361
+ <tr>
362
+ <td class="col-md-4">
363
+ <i>Type : </i> <code>string | string[]</code>
335
364
 
336
- </td>
337
- </tr>
365
+ </td>
366
+ </tr>
338
367
 
339
- <tr>
340
- <td class="col-md-4">
341
- <i>Optional</i>
342
- </td>
343
- </tr>
344
368
 
369
+ <tr>
370
+ <td class="col-md-4">
371
+ <i>Optional</i>
372
+ </td>
373
+ </tr>
345
374
 
346
375
 
347
376
 
348
- <tr>
349
- <td class="col-md-4">
350
- <div class="io-description"><p>Array of service urls to translation, don&#39;t add the language it will be added e.g. <a href="http://net1/trans/en">http://net1/trans/en</a>
377
+
378
+ <tr>
379
+ <td class="col-md-4">
380
+ <div class="io-description"><p>Array of service urls to translation, don&#39;t add the language it will be added e.g. <a href="http://net1/trans/en">http://net1/trans/en</a>
351
381
  Keep in mind that the url should be the prefix and not contain any suffix.</p>
352
382
  </div>
353
- </td>
354
- </tr>
355
- </tbody>
356
- </table>
357
- </section>
358
- </div>
383
+ </td>
384
+ </tr>
385
+ </tbody>
386
+ </table>
387
+ </section>
388
+ </div>
359
389
 
360
390
 
361
391
  </div>
@@ -399,6 +429,24 @@ Keep in mind that the url should be the prefix and not contain any suffix.</p>
399
429
 
400
430
  <script>
401
431
  $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
432
+ var updateDarkModeSwitchOffset = function () {
433
+ var content = document.querySelector('.content');
434
+ var scrollbarWidth = 0;
435
+
436
+ if (content) {
437
+ scrollbarWidth = Math.max(0, content.offsetWidth - content.clientWidth);
438
+ }
439
+
440
+ document.documentElement.style.setProperty(
441
+ '--content-scrollbar-width',
442
+ scrollbarWidth + 'px'
443
+ );
444
+ };
445
+
446
+ updateDarkModeSwitchOffset();
447
+ requestAnimationFrame(updateDarkModeSwitchOffset);
448
+ window.addEventListener('resize', updateDarkModeSwitchOffset);
449
+
402
450
  checkToggle(darkModeState);
403
451
  if ($darkModeToggleSwitchers.length > 0) {
404
452
  for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
@@ -414,7 +462,6 @@ Keep in mind that the url should be the prefix and not contain any suffix.</p>
414
462
  <script src="../js/libs/lit-html.js"></script>
415
463
 
416
464
  <script src="../js/menu-wc.js" defer></script>
417
- <script nomodule src="../js/menu-wc_es5.js" defer></script>
418
465
 
419
466
  <script src="../js/libs/bootstrap-native.js"></script>
420
467