@yuuvis/client-framework 2.8.2 → 2.9.0

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

@@ -58,6 +58,11 @@ export declare class QueryListComponent {
      * The query to execute (SearchQuery object or CMIS query string).
      */
     query: import("@angular/core").InputSignal<string | SearchQuery | null | undefined>;
+    /**
+     * Optional property name to use as unique identifier for items.
+     * If not provided, the index of the item in the result set will be used.
+     */
+    idProperty: import("@angular/core").InputSignal<string | null>;
     /**
      * Optional transformer function to map SearchResultItem to a custom format.
      */
@@ -78,7 +83,6 @@ export declare class QueryListComponent {
     autoSelect: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
     /**
      * Event emitted when items are selected. Emits an array of selected item indices.
-     *
      */
     itemSelect: import("@angular/core").OutputEmitterRef<number[]>;
     /**
@@ -95,6 +99,7 @@ export declare class QueryListComponent {
     queryResult: import("@angular/core").OutputEmitterRef<{
         totalCount: number;
     }>;
+    dropInSize: import("@angular/core").Signal<number>;
     /**
      * The list of result items after applying the optional transformer.
      */
@@ -132,6 +137,38 @@ export declare class QueryListComponent {
     onItemDoubleClick(idx: number, event: MouseEvent): void;
     onDragSelectChange(sel: number[]): void;
     onDragSelect(sel: number[]): void;
+    /**
+     * Updates an item in the list at the specified index with the provided value.
+     * The value should match the type returned by the transformer function, if provided.
+     * If you did not provide a transformer, the value should be of type SearchResultItem.
+     *
+     * Use this method for optimistic updates of list items. The updates be removed
+     * when the user navigates to another search result page.
+     *
+     * @param index Index of the item to update.
+     * @param value The new value for the item.
+     */
+    updateListItems(updates: {
+        index: number;
+        value: unknown;
+    }[]): void;
+    /**
+     * Optional array of items to be shown in addition to the query results.
+     * These items will be prepended to the list of query results and visually
+     * highlighted. They will also be affected by selection and drag-selection.
+     *
+     * Use this input to "drop in" items, for example when creating features
+     * like pasting items into a list where they would otherwise not appear due
+     * to the current query/filter.
+     *
+     * Changing the page of the query will remove the drop-in items again, as
+     * they are meant to be temporary.
+     *
+     * @param items The items to drop into the list.
+     * @param scrollTo If `true`, the list will scroll to the top after dropping
+     * in the items. Default is `true`.
+     */
+    dropItems(items: Record<string, unknown>[], scrollTo?: boolean): void;
     /**
      * Selects multiple items in the list.
      */
@@ -148,5 +185,5 @@ export declare class QueryListComponent {
     changePage(pe: PageEvent): void;
     goToPage(page: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<QueryListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<QueryListComponent, "yuv-query-list", never, { "query": { "alias": "query"; "required": false; "isSignal": true; }; "transformer": { "alias": "transformer"; "required": false; "isSignal": true; }; "preventChangeUntil": { "alias": "preventChangeUntil"; "required": false; "isSignal": true; }; "autoSelect": { "alias": "autoSelect"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "enableDragSelect": { "alias": "enableDragSelect"; "required": false; "isSignal": true; }; "multiselect": { "alias": "multiselect"; "required": false; "isSignal": true; }; "selfHandleSelection": { "alias": "selfHandleSelection"; "required": false; "isSignal": true; }; }, { "itemSelect": "itemSelect"; "dragSelectChange": "dragSelectChange"; "itemDoubleClick": "itemDoubleClick"; "queryResult": "queryResult"; }, ["itemTemplate", "emptyTemplate"], never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<QueryListComponent, "yuv-query-list", never, { "query": { "alias": "query"; "required": false; "isSignal": true; }; "idProperty": { "alias": "idProperty"; "required": false; "isSignal": true; }; "transformer": { "alias": "transformer"; "required": false; "isSignal": true; }; "preventChangeUntil": { "alias": "preventChangeUntil"; "required": false; "isSignal": true; }; "autoSelect": { "alias": "autoSelect"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "enableDragSelect": { "alias": "enableDragSelect"; "required": false; "isSignal": true; }; "multiselect": { "alias": "multiselect"; "required": false; "isSignal": true; }; "selfHandleSelection": { "alias": "selfHandleSelection"; "required": false; "isSignal": true; }; }, { "itemSelect": "itemSelect"; "dragSelectChange": "dragSelectChange"; "itemDoubleClick": "itemDoubleClick"; "queryResult": "queryResult"; }, ["itemTemplate", "emptyTemplate"], never, true, never>;
 }

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

@@ -1,5 +1,6 @@
 import { ElementRef, OnInit, Signal } from '@angular/core';
 import { DmsObject, ResolvedObjectConfigItem, SearchQuery, SearchResultItem } from '@yuuvis/client-core';
+import { MatMenuTrigger } from '@angular/material/menu';
 import { Action } from '@yuuvis/client-framework/actions';
 import { QueryListComponent } from '@yuuvis/client-framework/query-list';
 import { ObjectFlavor } from '@yuuvis/client-shell-core';
@@ -16,6 +17,7 @@ export declare class TileListComponent implements OnInit {
     menu: Signal<import("@angular/material/menu").MatMenu | null>;
     emptyContent: Signal<ElementRef<any> | undefined>;
     list: Signal<QueryListComponent>;
+    menuTriggers: Signal<readonly MatMenuTrigger[]>;
     transformer: (res: SearchResultItem[]) => {
         actions: Action[];
         id: string;
@@ -75,6 +77,7 @@ export declare class TileListComponent implements OnInit {
     appliedFlavor?: ObjectFlavor;
     /**
      * The search query to be executed. This may be a SearchQuery object or a CMIS query statement.
+     * Ensure that the query includes the object type ID field to allow proper tile rendering.
      */
     query: import("@angular/core").InputSignal<string | SearchQuery | null | undefined>;
     preselect: import("@angular/core").InputSignal<string[]>;
@@ -129,11 +132,43 @@ export declare class TileListComponent implements OnInit {
     onListItemsSelect(sel: number[]): void;
     refresh(): void;
     applyFlavor(flavor: ObjectFlavor): void;
+    /**
+     * Updates an item in the list at the specified index with the provided value.
+     *
+     * Use this method for optimistic updates of list items. The updates be removed
+     * when the user navigates to another search result page.
+     *
+     * @param index Index of the item to update.
+     * @param value The new value for the item.
+     */
+    updateListItems(updates: {
+        index: number;
+        value: TileData;
+    }[]): void;
+    /**
+     * Updates the tile list with the provided DmsObjects. Only tiles that are
+     * already present in the list will be updated. The update is based on
+     * the object ID and will be gone when the user navigates to another search
+     * result page. Use this method for optimistic updates.
+     * @param listItems The DmsObjects to update the tiles with.
+     */
+    updateTileList(listItems: DmsObject[]): void;
+    /**
+     * Clears the current selection.
+     * @param silent If true, the selectionChange event will not be emitted.
+     */
     clearSelection(silent?: boolean): void;
+    /**
+     * Selects the next item in the list. If the last item is already selected,
+     * it wraps around to the first item. Does nothing if no item is currently selected.
+     */
     selectNext(): void;
+    /**
+     * Selects the previous item in the list. If the first item is already selected,
+     * it wraps around to the last item. Does nothing if no item is currently selected.
+     */
     selectPrev(): void;
     private _selectionToTileData;
-    updateTileList(listItems: DmsObject[]): void;
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TileListComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TileListComponent, "yuv-tile-list", never, { "bucket": { "alias": "bucket"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "multiselect": { "alias": "multiselect"; "required": false; "isSignal": true; }; "dense": { "alias": "dense"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; "flavor": { "alias": "flavor"; "required": false; "isSignal": true; }; "query": { "alias": "query"; "required": false; "isSignal": true; }; "preselect": { "alias": "preselect"; "required": false; "isSignal": true; }; "highlights": { "alias": "highlights"; "required": false; "isSignal": true; }; "preventChangeUntil": { "alias": "preventChangeUntil"; "required": false; "isSignal": true; }; "autoSelect": { "alias": "autoSelect"; "required": false; "isSignal": true; }; "disableCustomContextMenu": { "alias": "disableCustomContextMenu"; "required": false; "isSignal": true; }; }, { "itemSelect": "itemSelect"; "tileCopy": "tileCopy"; "tileCut": "tileCut"; "busy": "busy"; "queryResult": "queryResult"; "selectionChange": "selectionChange"; "itemDblClick": "itemDblClick"; "ctxMenu": "ctxMenu"; }, ["menuComponent", "emptyContent"], ["yuv-tile-actions-menu, [yuv-tile-actions-menu]", "*"], true, never>;