@scion/components 22.3.0 → 22.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scion/components",
-  "version": "22.3.0",
+  "version": "22.5.0",
   "description": "Provides a collection of Angular components and directives primarily for use in SCION libraries such as `@scion/workbench` and `@scion/microfrontend-platform`. This library is not a comprehensive component library as its focus is on SCION requirements.",
   "license": "EPL-2.0",
   "private": false,
@@ -78,12 +78,12 @@
     "@angular/common": "^22.0.0",
     "@angular/animations": "^22.0.0",
     "@angular/cdk": "^22.0.0",
-    "@scion/toolkit": "^2.2.0",
+    "@scion/toolkit": "^2.3.0",
     "rxjs": "^7.8.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/SchweizerischeBundesbahnen/scion-toolkit.git"
+    "url": "git+https://github.com/SchweizerischeBundesbahnen/scion-toolkit.git"
   },
   "sideEffects": false,
   "module": "fesm2022/scion-components.mjs",

package/types/scion-components-common.d.ts

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { Signal, Injector, Provider, DestroyableInjector, Binding, Type, TemplateRef } from '@angular/core';
+import { Signal, Injector, Provider, DestroyableInjector, Binding, Type, TemplateRef, InjectionToken, WritableSignal } from '@angular/core';
 import { Observable } from 'rxjs';
 import { ComponentType } from '@angular/cdk/portal';
 
@@ -181,5 +181,39 @@ interface SciTemplateDescriptor {
     };
 }
 
-export { SciAttributesDirective, SciComponentOutletDirective, assertInInjectionContext, coerceSignal, createDestroyableInjector, toLazyObservable };
+/**
+ * DI token providing the current locale to SCION components for localizing dates and numbers.
+ *
+ * Defaults to {@link LOCALE_ID}. Changing the locale updates formatting in SCION components, unless overridden at the component level.
+ *
+ * Change the locale at runtime as follows:
+ * ```ts
+ * inject(SCI_LOCALE).set('de-CH');
+ * ```
+ *
+ * Angular includes only `en-US` by default. Register other locales via `registerLocaleData()`, typically in an environment initializer at app startup:
+ *
+ * ```ts
+ * import {bootstrapApplication} from '@angular/platform-browser';
+ * import {provideEnvironmentInitializer} from '@angular/core';
+ * import {registerLocaleData} from '@angular/common';
+ *
+ * import localeDeCH from '@angular/common/locales/de-CH';
+ * import localeFrCH from '@angular/common/locales/fr-CH';
+ * import localeItCH from '@angular/common/locales/it-CH';
+ *
+ * bootstrapApplication(AppComponent, {
+ *   providers: [
+ *     provideEnvironmentInitializer(() => {
+ *       registerLocaleData(localeDeCH);
+ *       registerLocaleData(localeFrCH);
+ *       registerLocaleData(localeItCH);
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const SCI_LOCALE: InjectionToken<WritableSignal<string>>;
+
+export { SCI_LOCALE, SciAttributesDirective, SciComponentOutletDirective, assertInInjectionContext, coerceSignal, createDestroyableInjector, toLazyObservable };
 export type { MaybeSignal, SciComponentDescriptor, SciTemplateDescriptor };

package/types/scion-components-icon.d.ts

@@ -60,61 +60,8 @@ declare class SciIconComponent {
  * @import url('https://fonts.googleapis.com/css2?family=Material+Symbols+Rounded:opsz,wght,FILL@20..24,400,0&display=block');
  * ```
  *
- * SCION uses the following built-in icons:
- * - scion.add               : Add an item
- * - scion.add_large         : Add an item (large)
- * - scion.bin               : Bin symbol
- * - scion.checkmark         : Indicates a selected option
- * - scion.chevron_down      : Chevron down symbol
- * - scion.chevron_left      : Chevron left symbol
- * - scion.chevron_right     : Chevron right symbol
- * - scion.chevron_up        : Chevron up symbol
- * - scion.clear             : Clear items
- * - scion.close             : Close a popover
- * - scion.collapse_all      : Collapse all items
- * - scion.copy              : Copy an item
- * - scion.delete            : Delete an item
- * - scion.dirty             : Indicates unsaved data
- * - scion.drag_handle       : Drag or move an item
- * - scion.duplicate         : Duplicate an item
- * - scion.edit              : Edit an item
- * - scion.emdash            : Em dash symbol
- * - scion.envelope          : Envelope symbol
- * - scion.envelope_closed   : Indicates a closed envelope
- * - scion.envelope_opened   : Indicates an opened envelope
- * - scion.expand_all        : Expand an item
- * - scion.external_link     : Open link in a new tab
- * - scion.filter            : Set or change a filter
- * - scion.find              : Find an item
- * - scion.folder            : Directory symbol
- * - scion.help              : Indicates help, support, or documentation
- * - scion.hide              : Hide a panel
- * - scion.magnifier         : Magnifier symbol
- * - scion.minimize          : Minimize a panel
- * - scion.minus             : Minus sign
- * - scion.modified          : Indicates modified data
- * - scion.more_horizontal   : Show a popover to the left or right
- * - scion.more_vertical     : Show a popover above or below
- * - scion.new               : Create an item
- * - scion.new_large         : Create an item (large)
- * - scion.paste             : Paste from clipboard
- * - scion.pen               : Pen symbol
- * - scion.pin               : Pin an item
- * - scion.pinned            : Indicates a pinned item
- * - scion.placeholder_frame : Placeholder symbol
- * - scion.placeholder_image : Placeholder symbol for an image
- * - scion.plus              : Plus sign
- * - scion.plus_large        : Plus sign (large)
- * - scion.remove            : Remove an item (x)
- * - scion.remove_minus      : Remove an item (-)
- * - scion.reset             : Reset a form
- * - scion.search            : Search for an item
- * - scion.sort_ascending    : Sort items in ascending order (A-Z, 0-9)
- * - scion.sort_by           : Change sort order
- * - scion.sort_descending   : Sort items in descending order (Z-A, 9-0)
- * - scion.user              : User symbol
- *
- * To not replace built-in icons, the icon provider can return `undefined` for icons starting with the `scion.` prefix.
+ * Built-in SCION icons start with the `scion.` prefix. To not replace SCION icons, the icon provider can return `undefined` for icons starting with the `scion.` prefix.
+ * Refer to https://icons.scion.vercel.app for available SCION icons.
  *
  * The function can call `inject` to get any required dependencies.
  *
@@ -130,7 +77,7 @@ declare function provideIconProvider(iconProviderFn: SciIconProviderFn | undefin
  * Alternatively, the icon provider can return a descriptor, allowing for additional configuration such as inputs.
  * Inputs are available as input properties in the component. The component can use the inputs to render the icon.
  *
- * Icon keys used by SCION start with the `scion.` prefix. To not replace built-in icons, the icon provider can
+ * Icon keys used by SCION start with the `scion.` prefix. To not replace SCION icons, the icon provider can
  * return `undefined` for icons starting with the `scion.` prefix.
  *
  * An icon provider can be registered via {@link provideIconProvider} function.