@quadrel-enterprise-ui/framework 21.4.1 → 21.4.2

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quadrel-enterprise-ui/framework",
3
- "version": "21.4.1",
3
+ "version": "21.4.2",
4
4
  "exports": {
5
5
  "./jest-preset": "./jest-preset.js",
6
6
  "./package.json": {
@@ -2141,6 +2141,17 @@ interface QdTableRefreshConfig {
2141
2141
 
2142
2142
  /**
2143
2143
  * @description Type definition for tree data row object, including optional nested rows.
2144
+ *
2145
+ * A key without a column in "QdTreeConfig" is metadata. The tree never renders it, but keeps it on the row,
2146
+ * so it reaches the secondary action handlers. Use it for values that only the application needs,
2147
+ * for example the identifier of a record.
2148
+ *
2149
+ * @example
2150
+ * ```ts
2151
+ * type Columns = 'article' | 'mass' | 'recordId';
2152
+ *
2153
+ * const data: QdTreeData<Columns> = [{ article: 'Coffee', mass: 10, recordId: '0815' }];
2154
+ * ```
2144
2155
  */
2145
2156
  type QdTreeDataRow<T extends string> = Partial<Record<T, QdTreeDataValue | QdTreeDataValue[]>> & {
2146
2157
  uid?: string | number;
@@ -15901,6 +15912,9 @@ type QdTreeActionResult = void | Observable<boolean>;
15901
15912
  interface QdTreeConfig<T extends string> {
15902
15913
  /**
15903
15914
  * @description Defines the columns of the tree.
15915
+ *
15916
+ * Only configured columns are rendered. A key of the tree data without a column here is metadata:
15917
+ * it stays on the row and reaches the handlers, but the tree shows no column for it.
15904
15918
  */
15905
15919
  columns: QdTreeConfigColumn<T>[];
15906
15920
  /**