@yuuvis/client-framework 2.0.4 → 2.0.6

package/lib/assets/i18n/de.json

@@ -28,6 +28,7 @@
   "yuv.form.element.datetime.calendar.cancel": "Abbrechen",
   "yuv.form.element.datetime.calendar.select": "Auswählen",
   "yuv.form.element.datetime.calendar.today": "Heute",
+  "yuv.form.element.organization-set.classify.icon.title": "",
   "yuv.form.element.organization.classify.icon.title": "",
   "yuv.form.element.organization.user.not-found": "Benutzer nicht gefunden",
   "yuv.form.element.range-select-date.custom.overlay.button.apply": "Anwenden",
@@ -97,6 +98,8 @@
   "yuv.object-summary.load.error": "",
   "yuv.sequence-list.form.nextAssignee": "Empfänger",
   "yuv.sequence-list.form.task": "Aufgabe",
+  "yuv.simple-search.label": "Suchen",
+  "yuv.simple-search.submit": "Suche absenden",
   "yuv.tile-config.button.close": "Schließen",
   "yuv.tile-config.button.save": "Speichern",
   "yuv.tile-config.details.empty.description": "",

package/lib/assets/i18n/en.json

@@ -28,6 +28,7 @@
   "yuv.form.element.datetime.calendar.cancel": "Cancel",
   "yuv.form.element.datetime.calendar.select": "Select",
   "yuv.form.element.datetime.calendar.today": "Today",
+  "yuv.form.element.organization-set.classify.icon.title": "",
   "yuv.form.element.organization.classify.icon.title": "",
   "yuv.form.element.organization.user.not-found": "User not found",
   "yuv.form.element.range-select-date.custom.overlay.button.apply": "Apply",
@@ -97,6 +98,8 @@
   "yuv.object-summary.load.error": "",
   "yuv.sequence-list.form.nextAssignee": "Recipient",
   "yuv.sequence-list.form.task": "Task",
+  "yuv.simple-search.label": "Search",
+  "yuv.simple-search.submit": "Submit search",
   "yuv.tile-config.button.close": "Close",
   "yuv.tile-config.button.save": "Save",
   "yuv.tile-config.details.empty.description": "",

package/list/lib/list-item.directive.d.ts

@@ -1,10 +1,28 @@
 import { Highlightable } from '@angular/cdk/a11y';
 import * as i0 from "@angular/core";
+/**
+ * Directive for list items. It is used in the `yuvList` component
+ * to keep track of active and selected items. Every element with this
+ * directive will be treated as a list item and can be selected and focused.
+ *
+ *```html
+ * <yuv-list (itemSelect)="itemSelected($event)">
+ *   <div yuvListItem>Entry #1</div>
+ *   <div yuvListItem>Entry #2</div>
+ * </yuv-list>
+ * ```
+ */
 export declare class ListItemDirective implements Highlightable {
     #private;
     onClick?: (evt: MouseEvent) => void;
     disabled?: boolean | undefined;
+    /**
+     * Whether the item is active or not.
+     */
     active: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Whether the item is selected or not.
+     */
     selected: import("@angular/core").InputSignal<boolean>;
     selectedInput: import("@angular/core").WritableSignal<any>;
     activeInput: import("@angular/core").WritableSignal<any>;

package/list/lib/list.component.d.ts

@@ -3,10 +3,10 @@ import { ListItemDirective } from './list-item.directive';
 import * as i0 from "@angular/core";
 /**
  * Component rendering a simple list of items. It supports keyboard
- * navigation as well as accessability. To create a list just wrapp
+ * navigation as well as accessibility. To create a list just wrap
  * `yuvListItem` elements into this component:
  *
- * ```ts
+ * ```html
  * <yuv-list (itemSelect)="itemSelected($event)">
  *   <div yuvListItem>Entry #1</div>
  *   <div yuvListItem>Entry #2</div>
@@ -21,12 +21,34 @@ export declare class ListComponent implements OnDestroy {
     private _keyManager;
     private _selection;
     private _lastSelection?;
+    /**
+     * If `true`, multiple items can be selected at once.
+     */
     multiselect: import("@angular/core").InputSignal<boolean>;
+    /**
+     * If `true`, the component will handle selection itself. This means that
+     * the parent component will be responsible for styling the selected and
+     * focused items. If `false`, the component will take care of visualizing
+     * the selection and focus states.
+     * @default false
+     */
     selfHandleSelection: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Emits the selected items indices.
+     * @type {output<number[]>}
+     */
     itemSelect: import("@angular/core").OutputEmitterRef<number[]>;
+    /**
+     * Emits the index of the item that has focus.
+     * @type {output<number>}
+     */
     itemFocus: import("@angular/core").OutputEmitterRef<number>;
     selectOnEnter: boolean;
     horizontal: boolean;
+    /**
+     * If `true`, the list will not allow selection of items.
+     * This is useful for lists that are used for display purposes only.
+     */
     disableSelection: import("@angular/core").InputSignal<boolean>;
     select(index: number, shiftKey?: boolean, ctrlKey?: boolean): void;
     /**

package/metadata-form/lib/metadata-form-element-registry.service.d.ts

@@ -2,7 +2,19 @@ import { TemplateRef } from '@angular/core';
 import { Situation } from '@yuuvis/client-core';
 import * as i0 from "@angular/core";
 /**
- * Registration service for form elements rendered within an object form.
+ * Object forms are used to render and edit metadata of DMS objects. Each property
+ * of an object can be rendered in a diffenrent way, depending on the type of the property.
+ * This service allows to register and retrieve templates for rendering these form elements.
+ *
+ * You can register templates for different situations like EDIT, SEARCH, and CREATE.
+ * The templates will then be used to render the form elements in the object form component.
+ *
+ * So based on the property type you can register custom templates for rendering certain
+ * form elements. This is useful if you want to render a property in a different way.
+ *
+ * Example:
+ * Having a number property representing a rating, you might want to render it as
+ * a list of stars instead of a simple input field.
  */
 export declare class MetadataFormElementRegistry {
     private _defaults;

package/metadata-form/lib/metadata-form-field/metadata-form-field.component.d.ts

@@ -3,6 +3,11 @@ import { ObjectTypeField } from '@yuuvis/client-core';
 import { MetadataFormFieldContext } from './metadata-form-field.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@yuuvis/client-framework/common";
+/**
+ * Component to render a metadata form field within an object form. These forms are
+ * created to render and edit metadata of DMS objects. This component is used as a wrapper
+ * for the actual form element, which is defined by the `formField` input.
+ */
 export declare class MetadataFormFieldComponent {
     #private;
     elementTemplate: import("@angular/core").WritableSignal<TemplateRef<any> | undefined>;

package/metadata-form/lib/object-metadata-element-error.directive.d.ts

@@ -2,7 +2,11 @@ import { OnInit } from '@angular/core';
 import { ObjectFormControl } from '@yuuvis/client-core';
 import * as i0 from "@angular/core";
 /**
- * Directive to apply an object-form related error to a mat-label element.
+ * Directive to apply an object-form related error to as inner text to an element.
+ * This could be used to render objec tform related errors in a custom element like <mat-error>.
+ *
+ * @example
+ * <mat-error [yuvObjectMetadataElementError]="myControl"></mat-error>
  */
 export declare class ObjectMetadataElementErrorDirective implements OnInit {
     #private;

package/metadata-form/lib/object-metadata-element-label.directive.d.ts

@@ -1,6 +1,14 @@
 import { OnInit } from '@angular/core';
 import { AbstractControl } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * Directive to apply styles to an object metadata element label based on its control status.
+ * Depending on the state of the control (dirty, error), it will add or remove specific classes
+ * to the label element. Thes clases could then be used to style the label accordingly.
+ *
+ * @example
+ * <mat-label [yuvObjectMetadataElementLabel]="myControl">My Label</mat-label>
+ */
 export declare class ObjectMetadataElementLabelDirective implements OnInit {
     #private;
     yuvObjectMetadataElementLabel: import("@angular/core").InputSignal<AbstractControl<any, any> | undefined>;

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@yuuvis/client-framework",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "author": "OPTIMAL SYSTEMS GmbH <npm@optimal-systems.de>",
   "license": "MIT",
   "peerDependencies": {
     "@angular/cdk": "^19.2.15",
     "@angular/common": "^19.2.1",
     "@angular/core": "^19.2.1",
-    "@yuuvis/client-core": "^2.0.4",
+    "@yuuvis/client-core": "^2.0.6",
+    "@yuuvis/client-shell-core": "^2.0.6",
     "modern-normalize": "^3.0.1"
   },
   "dependencies": {
     "@angular/material": "^19.2.15",
     "@ngrx/signals": "^19.2.0",
-    "@yuuvis/client-shell-core": "2.0.4",
-    "@yuuvis/material": "2.0.4",
-    "@yuuvis/media-viewer": "^1.0.0",
+    "@yuuvis/material": "2.0.6",
+    "@yuuvis/media-viewer": "^2.0.0",
     "angular-split": "^19.0.0",
     "tslib": "^2.3.0"
   },

package/simple-search/lib/simple-search/simple-search.component.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from '@angular/core';
 import { FormGroup } from '@angular/forms';
-import { SearchQuery } from '@yuuvis/client-core';
+import { SearchQuery, TranslateService } from '@yuuvis/client-core';
 import * as i0 from "@angular/core";
 export interface ObjectTypeAggregation {
     /**
@@ -17,9 +17,8 @@ export interface ObjectTypeAggregation {
     count: number;
 }
 export declare class SimpleSearchComponent {
-    private fb;
-    private searchService;
-    private systemService;
+    #private;
+    readonly translate: TranslateService;
     private _query;
     /**
      * The search query