@eui/core 22.0.0-alpha.2 → 22.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/CHANGELOG.md +83 -0
- package/docs/changelog.html +62 -0
- package/docs/interfaces/Edit-4.html +395 -0
- package/docs/interfaces/MigrateResult.html +356 -0
- package/docs/interfaces/Schema-21.html +1 -1
- package/docs/interfaces/Schema-22.html +368 -0
- package/docs/js/menu-wc.js +9 -0
- package/docs/js/search/search_index.js +2 -2
- package/docs/json/documentation.json +3418 -1546
- package/docs/llms.txt +68 -1
- package/docs/miscellaneous/functions.html +1441 -0
- package/docs/miscellaneous/variables.html +407 -0
- package/docs/overview.html +1 -1
- package/docs/properties.html +1 -1
- package/package.json +2 -2
- package/schematics/collection.json +5 -0
- package/schematics/migrate-all/index.js +1 -0
- package/schematics/migrate-all/index.js.map +1 -1
- package/schematics/migrate-to-signals/index.d.ts +24 -0
- package/schematics/migrate-to-signals/index.js +514 -0
- package/schematics/migrate-to-signals/index.js.map +1 -0
- package/schematics/migrate-to-signals/signal-map.d.ts +17 -0
- package/schematics/migrate-to-signals/signal-map.js +354 -0
- package/schematics/migrate-to-signals/signal-map.js.map +1 -0
package/docs/llms.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# eui documentation
|
|
2
2
|
|
|
3
|
-
> Generated by compodoc 2.0.0 at 2026-
|
|
3
|
+
> Generated by compodoc 2.0.0 at 2026-09-09T16:19:00.683Z, llm-md export.
|
|
4
4
|
|
|
5
5
|
## Modules
|
|
6
6
|
|
|
@@ -895,6 +895,15 @@ Properties:
|
|
|
895
895
|
- `replacement: string`
|
|
896
896
|
- `start: number`
|
|
897
897
|
|
|
898
|
+
### Edit
|
|
899
|
+
|
|
900
|
+
File: `packages/core/schematics/migrate-to-signals/index.ts`
|
|
901
|
+
|
|
902
|
+
Properties:
|
|
903
|
+
- `end: number`
|
|
904
|
+
- `replacement: string`
|
|
905
|
+
- `start: number`
|
|
906
|
+
|
|
898
907
|
### EuiComponentEntry
|
|
899
908
|
|
|
900
909
|
File: `packages/core/schematics/migrate/replacements/eui-modules.ts`
|
|
@@ -1006,6 +1015,14 @@ Properties:
|
|
|
1006
1015
|
- `path?: string`
|
|
1007
1016
|
- `useClassArray?: boolean`
|
|
1008
1017
|
|
|
1018
|
+
### MigrateResult
|
|
1019
|
+
|
|
1020
|
+
File: `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1021
|
+
|
|
1022
|
+
Properties:
|
|
1023
|
+
- `editCount: number`
|
|
1024
|
+
- `source: string`
|
|
1025
|
+
|
|
1009
1026
|
### MigrationResult
|
|
1010
1027
|
|
|
1011
1028
|
File: `packages/core/schematics/migrate-eui-tabs/index.ts`
|
|
@@ -1233,6 +1250,14 @@ Properties:
|
|
|
1233
1250
|
|
|
1234
1251
|
### Schema
|
|
1235
1252
|
|
|
1253
|
+
File: `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1254
|
+
|
|
1255
|
+
Properties:
|
|
1256
|
+
- `dryRun?: boolean`
|
|
1257
|
+
- `path?: string`
|
|
1258
|
+
|
|
1259
|
+
### Schema
|
|
1260
|
+
|
|
1236
1261
|
File: `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1237
1262
|
|
|
1238
1263
|
Properties:
|
|
@@ -1357,6 +1382,8 @@ Properties:
|
|
|
1357
1382
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1358
1383
|
- `applyEdits(source: string, edits): string`
|
|
1359
1384
|
Defined in `packages/core/schematics/migrate-eui-tooltip/index.ts`
|
|
1385
|
+
- `applyEdits(source: string, edits): string`
|
|
1386
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1360
1387
|
- `applyReplacements(source: string, filePath: string, replacements: Map): string`
|
|
1361
1388
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1362
1389
|
- `buildBodyReplacement(source: string, content: TmplAstElement): string`
|
|
@@ -1369,6 +1396,8 @@ Properties:
|
|
|
1369
1396
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1370
1397
|
- `buildSelectorMap(): SelectorEntry[]`
|
|
1371
1398
|
Defined in `packages/core/schematics/add-eui-imports/selector-map.ts`
|
|
1399
|
+
- `buildTemplateRefMap(sourceFile, source: string, filePath: string, tree: Tree): Map<string, string>` — Builds a map of template reference variable names (#ref) to EUI class names. Parses the component's template (inline or external) and finds elements like: \<eui-alert #myAlert\> → myAlert → EuiAlertComponent \<input euiAutocomplete #ac\> → ac → EuiAutocompleteComponent Returns Map\<refName, euiClassName\>.
|
|
1400
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1372
1401
|
- `buildTruncatePipeEdit(chip: TmplAstElement, source: string, truncateValue: string): Edit | null`
|
|
1373
1402
|
Defined in `packages/core/schematics/migrate-eui-chip-list/index.ts`
|
|
1374
1403
|
- `collectChildElementRenames(element: TmplAstElement, edits): void`
|
|
@@ -1377,6 +1406,8 @@ Properties:
|
|
|
1377
1406
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1378
1407
|
- `collectEmptyMessageRename(element: TmplAstElement, edits): void`
|
|
1379
1408
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1409
|
+
- `collectEuiReferences(sourceFile, source: string, templateRefMap: Map): Map<string, ReadonlySet<string>>` — Scans the source file for class properties or variables typed as EUI component classes. Returns a map: localName → Set of signal property names. Handles:
|
|
1410
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1380
1411
|
- `collectInputRemovals(element: TmplAstElement, source: string, edits, filePath: string, context: SchematicContext): void`
|
|
1381
1412
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1382
1413
|
- `collectOutputChanges(element: TmplAstElement, source: string, edits, filePath: string, context: SchematicContext): void`
|
|
@@ -1417,6 +1448,8 @@ Properties:
|
|
|
1417
1448
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1418
1449
|
- `collectTemplateEmptyMessageRename(template: TmplAstTemplate, edits): void`
|
|
1419
1450
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1451
|
+
- `collectTemplateRefs(nodes, refMap: Map): void` — Recursively walks template AST nodes, collecting #refName → EUI class name mappings. For each element with a template reference (#ref), we try to resolve its EUI class: Match element tag name against EUI\_SELECTOR\_TO\_CLASS (e.g. 'eui-alert' → EuiAlertComponent) Match element attributes against attribute selectors (e.g. \[euiAutocomplete\] → EuiAutocompleteComponent)
|
|
1452
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1420
1453
|
- `ConsoleHttpErrorCallbackFn(error: HttpErrorResponse): void`
|
|
1421
1454
|
Defined in `packages/core/src/lib/services/errors/http-error-handler-callback-functions.ts`
|
|
1422
1455
|
- `convertLegacyInterpolations(value: string): string` — Converts legacy ngx-translate interpolations ({{var}}) to ICU-compatible format ({var}). Double braces are never valid ICU syntax, so any {{word}} is guaranteed to be legacy.
|
|
@@ -1437,6 +1470,8 @@ Properties:
|
|
|
1437
1470
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1438
1471
|
- `deduplicateEdits(edits): Edit[]`
|
|
1439
1472
|
Defined in `packages/core/schematics/migrate-eui-tooltip/index.ts`
|
|
1473
|
+
- `deduplicateEdits(edits): Edit[]`
|
|
1474
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1440
1475
|
- `defaultMemoize(projectionFn: AnyFn, isArgumentsEqual: unknown = isEqualCheck, isResultEqual: unknown = isEqualCheck): MemoizedProjection`
|
|
1441
1476
|
Defined in `packages/core/src/lib/services/store/ngrx_kit.ts`
|
|
1442
1477
|
- `defaultStateFn(state: any, selectors, props: any, memoizedProjector: MemoizedProjection): any`
|
|
@@ -1463,6 +1498,8 @@ Properties:
|
|
|
1463
1498
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1464
1499
|
- `findComponentDecorators(sourceFile): ts.Decorator[]`
|
|
1465
1500
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1501
|
+
- `findComponentMetadata(sourceFile, source: string): literal type | null` — Extracts
|
|
1502
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1466
1503
|
- `findDeclaringModule(modules, componentClassName: string): NgModuleInfo | undefined`
|
|
1467
1504
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1468
1505
|
- `findDecoratorImportsArray(sf, source: string, decoratorStartHint: number): ImportsArrayInfo | null`
|
|
@@ -1499,6 +1536,8 @@ Properties:
|
|
|
1499
1536
|
Defined in `packages/core/src/lib/services/app/eui-startup.ts`
|
|
1500
1537
|
- `getCoreProviders(): Provider[]`
|
|
1501
1538
|
Defined in `packages/core/src/lib/services/app/eui-startup.ts`
|
|
1539
|
+
- `getDecoratorName(callExpr): string | null`
|
|
1540
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1502
1541
|
- `getDependencyProviders(): Provider[]`
|
|
1503
1542
|
Defined in `packages/core/src/lib/services/app/eui-startup.ts`
|
|
1504
1543
|
- `getEndImportBlockPos(lines): number` — Finds the position where the import block ends. Looks for
|
|
@@ -1529,24 +1568,32 @@ Properties:
|
|
|
1529
1568
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1530
1569
|
- `getTemplateSelectors(tree: Tree, tsPath: string, decorator, source: string): Set<string>`
|
|
1531
1570
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1571
|
+
- `getTypeAnnotationName(typeNode): string | null`
|
|
1572
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1532
1573
|
- `GrowlHttpErrorCallbackFn(error: HttpErrorResponse, injector: Injector): void`
|
|
1533
1574
|
Defined in `packages/core/src/lib/services/errors/http-error-handler-callback-functions.ts`
|
|
1534
1575
|
- `hasAttribute(element: TmplAstElement, name: string): boolean`
|
|
1535
1576
|
Defined in `packages/core/schematics/migrate-eui-alert/index.ts`
|
|
1536
1577
|
- `hasEuiButtonAttribute(element: TmplAstElement): boolean`
|
|
1537
1578
|
Defined in `packages/core/schematics/migrate-eui-button/index.ts`
|
|
1579
|
+
- `hasEuiReference(source: string): boolean` — Quick check: does the file reference any EUI class name from the signal map?
|
|
1580
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1538
1581
|
- `hasEuiTableAttribute(element: TmplAstElement): boolean`
|
|
1539
1582
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1540
1583
|
- `hasModuleInArray(array, moduleName: string, source: string): boolean`
|
|
1541
1584
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1542
1585
|
- `hasStandaloneFalse(decorator): boolean`
|
|
1543
1586
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1587
|
+
- `hasStringRefQuery(source: string): boolean` — Quick check: does the file have
|
|
1588
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1544
1589
|
- `iconMigrate(options: Schema): Rule`
|
|
1545
1590
|
Defined in `packages/core/schematics/icon-migrate/index.ts`
|
|
1546
1591
|
- `injectOptional(token, injector: unknown = inject(Injector)): T | null` — Safely resolves a service from the injector only when needed. Avoids instantiation errors that can occur with inject(..., { optional: true }) .
|
|
1547
1592
|
Defined in `packages/core/src/lib/helpers/injector.ts`
|
|
1548
1593
|
- `isArgumentsChanged(args: IArguments, lastArguments: IArguments, comparator: ComparatorFn)`
|
|
1549
1594
|
Defined in `packages/core/src/lib/services/store/ngrx_kit.ts`
|
|
1595
|
+
- `isAssignmentOperator(kind): boolean`
|
|
1596
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1550
1597
|
- `isAvatarElement(element: TmplAstElement): boolean`
|
|
1551
1598
|
Defined in `packages/core/schematics/migrate-eui-avatar/index.ts`
|
|
1552
1599
|
- `isChipElement(element: TmplAstElement): boolean`
|
|
@@ -1745,6 +1792,8 @@ Properties:
|
|
|
1745
1792
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1746
1793
|
- `migrateTemplateWithPaginator(source: string, filePath: string, context: SchematicContext): { output: string; hasPaginator: boolean }`
|
|
1747
1794
|
Defined in `packages/core/schematics/migrate-eui-table/index.ts`
|
|
1795
|
+
- `migrateToSignals(options: Schema = {}): Rule` — Migrates consumer code that accesses EUI component instances programmatically. When EUI migrated
|
|
1796
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1748
1797
|
- `migrateToStandalone(options: Schema = {}): Rule`
|
|
1749
1798
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1750
1799
|
- `migrateTypeScript(source: string, filePath: string, context: SchematicContext): { output: string; hasPaginator: boolean }`
|
|
@@ -1753,6 +1802,8 @@ Properties:
|
|
|
1753
1802
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1754
1803
|
- `migrateTypeScript(source: string, filePath: string, context: SchematicContext): string`
|
|
1755
1804
|
Defined in `packages/core/schematics/migrate-eui-tooltip/index.ts`
|
|
1805
|
+
- `migrateTypeScript(source: string, filePath: string, tree: Tree, context: SchematicContext): MigrateResult`
|
|
1806
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1756
1807
|
- `parseSelector(raw: string): { element: string | null; attributes: string[] }` — Parses a raw CSS-like selector string into element + attributes. Examples: "button\[euiButton\]" → { element: "button", attributes: \["euiButton"\] } "\[euiTooltip\]" → { element: null, attributes: \["euiTooltip"\] } "eui-tabs" → { element: "eui-tabs", attributes: \[\] } "input\[euiInputNumber\]\[formControlName\]" → { element: "input", attributes: \["euiInputNumber", "formControlName"\] }
|
|
1757
1808
|
Defined in `packages/core/schematics/add-eui-imports/selector-map.ts`
|
|
1758
1809
|
- `preInitApp(envConfig: EuiEnvConfig): Promise<EuiEnvConfig>` — Function to be used before the AppModule is bootstrapped. It is currently used to load dynamic configurations. It needs to be added in your application main.ts file.
|
|
@@ -1799,10 +1850,16 @@ Properties:
|
|
|
1799
1850
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1800
1851
|
- `replaceMwp(filePath: string, lines, index: number): boolean` — Applies MyWorkplace-specific replacements to a single line. Ported from csdr-engine/migrate/index.js replaceMwp. Returns true if the line was modified.
|
|
1801
1852
|
Defined in `packages/core/schematics/migrate/replacements/mwp.ts`
|
|
1853
|
+
- `resolveElementToEuiClass(element: TmplAstElement): string | null` — Given a template element, resolves it to an EUI class name by checking: Tag name: → look up 'eui-alert' in EUI\_SELECTOR\_TO\_CLASS Attribute selectors: → look up 'input\[euiAutocomplete\]' or '\[euiAutocomplete\]'
|
|
1854
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1855
|
+
- `resolveEuiClassName(node, sourceFile, templateRefMap: Map): string | null` — Resolves the EUI class name from a property declaration. Checks: type annotation → decorator class argument → template ref map.
|
|
1856
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1802
1857
|
- `resolveIcon(icon: string): string | undefined` — Resolve icon: first try exact match in ICON\_MAP, then apply suffix mapping
|
|
1803
1858
|
Defined in `packages/core/schematics/icon-migrate/index.ts`
|
|
1804
1859
|
- `resolveImports(matched, useClassArray: boolean): ImportToAdd[]`
|
|
1805
1860
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1861
|
+
- `resolveRefName(expr): string | null` — Resolves a reference name from an expression. Handles: ref , this.ref , this.\_ref
|
|
1862
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1806
1863
|
- `sessionStorageSync(platformId): function` (deprecated: it will be removed in the next major version) — Utility meta-reducer to load the state from the session storage
|
|
1807
1864
|
Defined in `packages/core/src/lib/services/store/reducers/meta.reducers.ts`
|
|
1808
1865
|
- `sessionStorageSync(reducer: ActionReducer): S` (deprecated: it will be removed in the next major version) — Utility meta-reducer to load the state from the session storage
|
|
@@ -1811,6 +1868,8 @@ Properties:
|
|
|
1811
1868
|
Defined in `packages/core/src/lib/services/store/reducers/meta.reducers.ts`
|
|
1812
1869
|
- `transformTranslations(translations: T): T` — Recursively walks a translation object and converts all legacy {{var}} interpolations to ICU-compatible {var} format in string leaf values.
|
|
1813
1870
|
Defined in `packages/core/src/lib/services/i18n/i18n-utils.ts`
|
|
1871
|
+
- `tryRewritePropertyAccess(node, euiRefs: Map, sourceFile, source: string): Edit | null` — Checks if a property access ref.prop should be rewritten to ref.prop() . We rewrite if: ref is tracked in euiRefs prop is in the signal set for that EUI class The access is NOT already a call expression (not ref.prop() or ref.prop(args) ) The access is NOT a write target (not ref.prop = value ) The access is NOT a template binding argument (those are unaffected)
|
|
1872
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1814
1873
|
- `unwrapExpression(expression): ts.Expression`
|
|
1815
1874
|
Defined in `packages/core/schematics/migrate-eui-accent/index.ts`
|
|
1816
1875
|
- `unwrapExpression(expression): ts.Expression`
|
|
@@ -1833,6 +1892,8 @@ Properties:
|
|
|
1833
1892
|
Defined in `packages/core/schematics/migrate-eui-tabs/index.ts`
|
|
1834
1893
|
- `unwrapExpression(expression): ts.Expression`
|
|
1835
1894
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1895
|
+
- `unwrapExpression(expression): ts.Expression`
|
|
1896
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1836
1897
|
- `updateDecoratorImportsArray(source: string, filePath: string, arrayNode, toAdd, toRemove): string`
|
|
1837
1898
|
Defined in `packages/core/schematics/add-eui-imports/index.ts`
|
|
1838
1899
|
- `updateEsImports(source: string, filePath: string, replacements: Map): string`
|
|
@@ -1877,6 +1938,8 @@ Properties:
|
|
|
1877
1938
|
Defined in `packages/core/schematics/migrate-eui-toolbar-menu/index.ts`
|
|
1878
1939
|
- `visitDir(dir: DirEntry, callback): void`
|
|
1879
1940
|
Defined in `packages/core/schematics/migrate-eui-tooltip/index.ts`
|
|
1941
|
+
- `visitDir(dir: DirEntry, callback): void`
|
|
1942
|
+
Defined in `packages/core/schematics/migrate-to-signals/index.ts`
|
|
1880
1943
|
- `visitDir(dir: DirEntry, callback): void`
|
|
1881
1944
|
Defined in `packages/core/schematics/migrate-to-standalone/index.ts`
|
|
1882
1945
|
- `visitExpressionForPipes(expr: AST, edits): void`
|
|
@@ -2094,6 +2157,10 @@ Properties:
|
|
|
2094
2157
|
Defined in `packages/core/src/lib/services/eui-timezone.service.ts`
|
|
2095
2158
|
- `EUI_DIRECTIVES: [] = ['euiButton', 'euiList', 'euiListItem']`
|
|
2096
2159
|
Defined in `packages/core/schematics/migrate-eui-accent/index.ts`
|
|
2160
|
+
- `EUI_SELECTOR_TO_CLASS: Record<string, string> = { '[euiBase]': 'BaseStatesDirective', '[euiDropdownItem]': 'EuiDropdownItemComponent', '[euiIconColored]': 'EuiIconColorComponent', '[euiListItem]': 'EuiListIte…` — Map of component/directive selectors to their class names. Used to resolve
|
|
2161
|
+
Defined in `packages/core/schematics/migrate-to-signals/signal-map.ts`
|
|
2162
|
+
- `EUI_SIGNAL_MAP: Record<string, ReadonlySet<string>> = { AppComponent: new Set(['appSubTitle', 'isShrinkHeaderActive', 'isSidebarHidden', 'isSidebarOpen', 'themeClass']), BaseStatesDirective: new Set(['euiBranding',…` — Auto-generated map of EUI component classes whose
|
|
2163
|
+
Defined in `packages/core/schematics/migrate-to-signals/signal-map.ts`
|
|
2097
2164
|
- `EUI_TIMEZONES: EuiTimeZone[] = [ { name: 'Europe/Andorra', desc: 'Andorra - Andorra (GMT+02:00)' }, { name: 'Asia/Dubai', desc: 'United Arab Emirates - Dubai (GMT+04:00)' }, { name: 'Asia/Kab…`
|
|
2098
2165
|
Defined in `packages/core/src/lib/services/eui-timezone.service.ts`
|
|
2099
2166
|
- `euiCoreRootGuardClass: unknown = (): EuiCoreRootGuardClass => new EuiCoreRootGuardClass()`
|