@openmfp/ngx 0.18.12 → 0.19.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmfp/ngx",
-  "version": "0.18.12",
+  "version": "0.19.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/openmfp/webcomponents.git"

package/types/openmfp-ngx.d.ts

@@ -141,11 +141,13 @@ interface FieldDefinition {
     requirePermission?: string;
 }
 
-type DashboardLanguage = 'en' | 'de';
 declare const DASHBOARD_I18N_KEYS: {
+    readonly TITLE: "title";
+    readonly DESCRIPTION: "description";
+    readonly EDIT_HOME_BUTTON: "editHomeButton";
+    readonly EDIT_CARDS_BUTTON: "editCardsButton";
     readonly UNSAVED_CHANGES: "unsavedChanges";
     readonly EDIT_CARDS: "editCards";
-    readonly EDIT_VIEW: "editView";
     readonly ACTIONS: "actions";
     readonly SAVE: "save";
     readonly CANCEL: "cancel";
@@ -159,17 +161,34 @@ declare const DASHBOARD_I18N_KEYS: {
     readonly RESIZABLE: "resizable";
 };
 type DashboardI18nKey = (typeof DASHBOARD_I18N_KEYS)[keyof typeof DASHBOARD_I18N_KEYS];
+/**
+ * The full set of dashboard chrome strings (toolbar buttons, dialogs, a11y
+ * labels). Client applications provide translated values through
+ * `DashboardConfig.i18n`; any key they omit falls back to `EN_DEFAULTS`.
+ */
+type DashboardTranslations = Record<DashboardI18nKey, string>;
+/**
+ * Built-in English strings. This is the only translation the library ships and
+ * the fallback used whenever a key is not supplied by the client through
+ * `DashboardConfig.i18n`.
+ */
+declare const EN_DEFAULTS: DashboardTranslations;
 
 /**
- * Holds the dashboard's current language and resolves translation keys for
- * the dashboard chrome (toolbar buttons, dialogs, a11y labels). Provided at
- * the `Dashboard` component level so every nested dashboard component shares
- * the same language signal — child components inject the same instance and
- * react to language changes automatically because `getTranslation` reads the
- * signal on every call.
+ * Resolves translation keys for the dashboard chrome (toolbar buttons,
+ * dialogs, a11y labels). Provided at the `Dashboard` component level so every
+ * nested dashboard component shares the same instance — child components
+ * inject it and react to translation changes automatically because
+ * `getTranslation` reads the `overrides` signal on every call.
+ *
+ * The library ships English only (`EN_DEFAULTS`). Client applications supply
+ * translated strings through `DashboardConfig.i18n`, which the `Dashboard`
+ * component pushes into `overrides`; switching language is just the client
+ * swapping that object. Any key not present in the overrides falls back to the
+ * English default, and finally to the key itself.
  */
 declare class DashboardI18nService {
-    readonly language: _angular_core.WritableSignal<DashboardLanguage>;
+    readonly overrides: _angular_core.WritableSignal<Partial<DashboardTranslations>>;
     getTranslation(key: DashboardI18nKey): string;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DashboardI18nService, never>;
     static ɵprov: _angular_core.ɵɵInjectableDeclaration<DashboardI18nService>;
@@ -241,16 +260,10 @@ interface DashboardButtonsSettings {
 }
 /** Top-level configuration for the `<mfp-dashboard>` component. */
 interface DashboardConfig {
-    /** Dashboard title rendered in the toolbar. */
-    title: string;
-    /** Optional subtitle shown below the title. */
-    description?: string;
     /** URL of the background image applied to the dashboard host element. */
     backgroundImageUrl?: string;
     /** Overrides for the built-in Edit View and Edit Cards toolbar buttons. */
     buttonsSettings?: DashboardButtonsSettings;
-    /** Extra action buttons rendered in the toolbar alongside the built-in ones. */
-    customActions?: ButtonSettings[];
     /** When `true`, shows the Edit View button in the toolbar, allowing the user to enter edit mode. */
     editable?: boolean;
     /** When `true`, the Edit View button is rendered before the custom actions instead of after. Defaults to `false`. */
@@ -291,12 +304,22 @@ declare class Dashboard implements OnInit, OnDestroy {
     private readonly hostEl;
     private readonly injector;
     private readonly sanitizer;
-    protected readonly i18n: DashboardI18nService;
+    protected readonly i18nService: DashboardI18nService;
     config: _angular_core.InputSignal<DashboardConfig>;
     sections: _angular_core.ModelSignal<SectionConfig[]>;
     cards: _angular_core.ModelSignal<CardConfig[]>;
     availableCards: _angular_core.InputSignal<CardConfig[]>;
-    language: _angular_core.InputSignal<DashboardLanguage>;
+    /** Extra action buttons rendered in the toolbar alongside the built-in ones. */
+    customActions: _angular_core.InputSignal<ButtonSettings[]>;
+    /**
+     * Full set of dashboard-chrome translations (title, description, toolbar
+     * buttons, dialogs, a11y labels). The library ships English only. Provide a
+     * complete `DashboardTranslations` to render the dashboard in another
+     * language, and swap it to switch language. When `null`, `undefined`, or an
+     * empty object, the built-in English defaults (`EN_DEFAULTS`) are used. See
+     * `DashboardTranslations` / `DashboardI18nKey` for the full key contract.
+     */
+    i18n: _angular_core.InputSignal<DashboardTranslations | null | undefined>;
     readonly saved: _angular_core.OutputEmitterRef<{
         sections: SectionConfig[];
         cards: CardConfig[];
@@ -307,9 +330,12 @@ declare class Dashboard implements OnInit, OnDestroy {
     }>;
     readonly unsavedChangesChange: _angular_core.OutputEmitterRef<boolean>;
     protected readonly i18nKeys: {
+        readonly TITLE: "title";
+        readonly DESCRIPTION: "description";
+        readonly EDIT_HOME_BUTTON: "editHomeButton";
+        readonly EDIT_CARDS_BUTTON: "editCardsButton";
         readonly UNSAVED_CHANGES: "unsavedChanges";
         readonly EDIT_CARDS: "editCards";
-        readonly EDIT_VIEW: "editView";
         readonly ACTIONS: "actions";
         readonly SAVE: "save";
         readonly CANCEL: "cancel";
@@ -352,7 +378,6 @@ declare class Dashboard implements OnInit, OnDestroy {
         '--dashboard-cols-lg': number;
         '--dashboard-cols-xl': number;
     }>;
-    protected customActions: _angular_core.Signal<ButtonSettings[]>;
     protected addedCardsIds: _angular_core.Signal<Set<string>>;
     protected editViewButton: _angular_core.Signal<{
         text: string;
@@ -448,7 +473,7 @@ declare class Dashboard implements OnInit, OnDestroy {
     private updateCardsForBreakpoint;
     private changeCardSettingsForXlPage;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<Dashboard, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Dashboard, "mfp-dashboard", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "sections": { "alias": "sections"; "required": false; "isSignal": true; }; "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "availableCards": { "alias": "availableCards"; "required": false; "isSignal": true; }; "language": { "alias": "language"; "required": false; "isSignal": true; }; }, { "sections": "sectionsChange"; "cards": "cardsChange"; "saved": "saved"; "actionButtonClick": "actionButtonClick"; "unsavedChangesChange": "unsavedChangesChange"; }, never, ["[slot=dashboard-subheader]"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Dashboard, "mfp-dashboard", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; "sections": { "alias": "sections"; "required": false; "isSignal": true; }; "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "availableCards": { "alias": "availableCards"; "required": false; "isSignal": true; }; "customActions": { "alias": "customActions"; "required": false; "isSignal": true; }; "i18n": { "alias": "i18n"; "required": false; "isSignal": true; }; }, { "sections": "sectionsChange"; "cards": "cardsChange"; "saved": "saved"; "actionButtonClick": "actionButtonClick"; "unsavedChangesChange": "unsavedChangesChange"; }, never, ["[slot=dashboard-subheader]"], true, never>;
 }
 
 /**
@@ -1503,5 +1528,5 @@ declare class MockCard {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<MockCard, "mfp-mock-card", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { BooleanValue, CARD_TYPES, Dashboard, DeclarativeForm, DeclarativeTable, DeclarativeTableCard, DeleteConfirmationDialog, Favorites, LinkValue, MockCard, ResourceField, ResourceFormDialog, SanitizeHtmlPipe, SecretValue, ServiceStatusCard, TagListValue, VisitedServiceCard, WhatsNew, defineDashboardElementMethods };
-export type { ButtonSettings, CardConfig, CardsType, CssRule, DashboardButtonsSettings, DashboardConfig, DeleteResourceConfirmationConfig, FieldDefinition, FieldFilterDefinition, FormFieldChangeEvent, FormFieldDefinition, FormFieldErrors, GenericResource, IconDesignType, ModalSettings, MountCfg, PropertyField, ResourceFieldButtonClickEvent, ResourceFormConfig, RuleCondition, SectionConfig, ServiceStatusItem, ServiceStatusValue, TableCardButtonSettings, TableCardConfig, TableCardFormState, TableCardSearchConfig, TableConfig, TableFieldDefinition, TagSettings, TransformType, UiSettings, ValueRule };
+export { BooleanValue, CARD_TYPES, DASHBOARD_I18N_KEYS, Dashboard, DashboardI18nService, DeclarativeForm, DeclarativeTable, DeclarativeTableCard, DeleteConfirmationDialog, EN_DEFAULTS, Favorites, LinkValue, MockCard, ResourceField, ResourceFormDialog, SanitizeHtmlPipe, SecretValue, ServiceStatusCard, TagListValue, VisitedServiceCard, WhatsNew, defineDashboardElementMethods };
+export type { ButtonSettings, CardConfig, CardsType, CssRule, DashboardButtonsSettings, DashboardConfig, DashboardI18nKey, DashboardTranslations, DeleteResourceConfirmationConfig, FieldDefinition, FieldFilterDefinition, FormFieldChangeEvent, FormFieldDefinition, FormFieldErrors, GenericResource, IconDesignType, ModalSettings, MountCfg, PropertyField, ResourceFieldButtonClickEvent, ResourceFormConfig, RuleCondition, SectionConfig, ServiceStatusItem, ServiceStatusValue, TableCardButtonSettings, TableCardConfig, TableCardFormState, TableCardSearchConfig, TableConfig, TableFieldDefinition, TagSettings, TransformType, UiSettings, ValueRule };