@genesislcap/foundation-entity-management 14.214.1 → 14.214.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.
Files changed (55) hide show
  1. package/dist/custom-elements.json +212 -862
  2. package/dist/dts/entities/entities.d.ts +132 -32
  3. package/dist/dts/entities/entities.d.ts.map +1 -1
  4. package/dist/esm/entities/entities.js +44 -10
  5. package/dist/esm/entities/entities.template.js +1 -1
  6. package/dist/foundation-entity-management.api.json +243 -1613
  7. package/dist/foundation-entity-management.d.ts +132 -32
  8. package/docs/api/foundation-entity-management.entitymanagement.createformuischema.md +2 -0
  9. package/docs/api/foundation-entity-management.entitymanagement.enablefilterbar.md +2 -0
  10. package/docs/api/foundation-entity-management.entitymanagement.entitylabel.md +1 -1
  11. package/docs/api/foundation-entity-management.entitymanagement.hidedelete.md +2 -0
  12. package/docs/api/foundation-entity-management.entitymanagement.hideedit.md +2 -0
  13. package/docs/api/foundation-entity-management.entitymanagement.md +10 -50
  14. package/docs/api/foundation-entity-management.entitymanagement.readevent.md +2 -0
  15. package/docs/api/foundation-entity-management.entitymanagement.readeventfn.md +3 -1
  16. package/docs/api/foundation-entity-management.entitymanagement.searchbarconfig.md +2 -0
  17. package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstofit.md +2 -0
  18. package/docs/api/foundation-entity-management.entitymanagement.updateformuischema.md +2 -0
  19. package/docs/api-report.md +33 -34
  20. package/package.json +21 -21
  21. package/docs/api/foundation-entity-management.entitymanagement.asyncadd.md +0 -18
  22. package/docs/api/foundation-entity-management.entitymanagement.asyncremove.md +0 -18
  23. package/docs/api/foundation-entity-management.entitymanagement.asyncupdate.md +0 -18
  24. package/docs/api/foundation-entity-management.entitymanagement.closemodal.md +0 -15
  25. package/docs/api/foundation-entity-management.entitymanagement.confirmdelete.md +0 -15
  26. package/docs/api/foundation-entity-management.entitymanagement.connect.md +0 -18
  27. package/docs/api/foundation-entity-management.entitymanagement.criteriachanged.md +0 -22
  28. package/docs/api/foundation-entity-management.entitymanagement.crudmenuwrapper.md +0 -13
  29. package/docs/api/foundation-entity-management.entitymanagement.deepclone.md +0 -17
  30. package/docs/api/foundation-entity-management.entitymanagement.disconnectedcallback.md +0 -15
  31. package/docs/api/foundation-entity-management.entitymanagement.editedentity.md +0 -13
  32. package/docs/api/foundation-entity-management.entitymanagement.editentitymodal.md +0 -11
  33. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisible.md +0 -11
  34. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisiblechanged.md +0 -15
  35. package/docs/api/foundation-entity-management.entitymanagement.emitcrud.md +0 -24
  36. package/docs/api/foundation-entity-management.entitymanagement.formuischema.md +0 -11
  37. package/docs/api/foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md +0 -24
  38. package/docs/api/foundation-entity-management.entitymanagement.hascontentinslot.md +0 -26
  39. package/docs/api/foundation-entity-management.entitymanagement.hasselectedentity.md +0 -13
  40. package/docs/api/foundation-entity-management.entitymanagement.headertempalate.md +0 -11
  41. package/docs/api/foundation-entity-management.entitymanagement.isserversidedatasource.md +0 -11
  42. package/docs/api/foundation-entity-management.entitymanagement.modalformtitle.md +0 -13
  43. package/docs/api/foundation-entity-management.entitymanagement.modalformtype.md +0 -13
  44. package/docs/api/foundation-entity-management.entitymanagement.readonly.md +0 -11
  45. package/docs/api/foundation-entity-management.entitymanagement.requestchanged.md +0 -22
  46. package/docs/api/foundation-entity-management.entitymanagement.searchbardataserver.md +0 -22
  47. package/docs/api/foundation-entity-management.entitymanagement.searchbarreqserver.md +0 -22
  48. package/docs/api/foundation-entity-management.entitymanagement.searchchanged.md +0 -22
  49. package/docs/api/foundation-entity-management.entitymanagement.selectedentity.md +0 -18
  50. package/docs/api/foundation-entity-management.entitymanagement.selectionchanged.md +0 -24
  51. package/docs/api/foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.md +0 -13
  52. package/docs/api/foundation-entity-management.entitymanagement.shouldhideeditincolumn.md +0 -13
  53. package/docs/api/foundation-entity-management.entitymanagement.submitentitychanges.md +0 -24
  54. package/docs/api/foundation-entity-management.entitymanagement.submitfailurenotification.md +0 -22
  55. package/docs/api/foundation-entity-management.entitymanagement.submitting.md +0 -11
@@ -134,6 +134,7 @@ export declare class EntityManagement extends EntityManagement_base {
134
134
  *
135
135
  * Requires {@link @genesislcap/foundation-comms#Connect | the connect class} to be registered with the
136
136
  * DI container
137
+ * @internal
137
138
  */
138
139
  protected connect: Connect;
139
140
  /**
@@ -146,8 +147,23 @@ export declare class EntityManagement extends EntityManagement_base {
146
147
  * @public
147
148
  */
148
149
  resourceName: string;
150
+ /**
151
+ * Name of the request on the Genesis server which fetches data for the form, example usage could
152
+ * include fetching additional data that is not available in the grid but required for the selected entity
153
+ * @public
154
+ */
149
155
  readEvent: string;
150
- readEventFn: (...args: any[]) => {};
156
+ /**
157
+ * Similar to readEvent but allows to provide function that will be executed before
158
+ * opening the form and yields data to the form
159
+ * @param entity - selected entity from the grid
160
+ * @returns object with data which will be used to prefill the form similarly to `defaultEntityValues`
161
+ * @public
162
+ */
163
+ readEventFn: (entity: any) => any;
164
+ /**
165
+ * @internal
166
+ */
151
167
  readonly: boolean;
152
168
  /**
153
169
  * Name of the event handler on the Genesis server which handles updating the entity
@@ -170,26 +186,26 @@ export declare class EntityManagement extends EntityManagement_base {
170
186
  */
171
187
  title: string;
172
188
  /**
173
- * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
189
+ * Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications
174
190
  * @public
175
191
  */
176
192
  entityLabel: string;
177
193
  /**
178
194
  * Whether to use the `applyTransactionAsync` function for *add* transactions
179
195
  * @remarks Defaults to false
180
- * @public
196
+ * @internal
181
197
  */
182
198
  asyncAdd: boolean;
183
199
  /**
184
200
  * Whether to use the `applyTransactionAsync` function for *remove* transactions
185
201
  * @remarks Defaults to false
186
- * @public
202
+ * @internal
187
203
  */
188
204
  asyncRemove: boolean;
189
205
  /**
190
206
  * Whether to use the `applyTransactionAsync` function for *update* transactions
191
207
  * @remarks Defaults to true
192
- * @public
208
+ * @internal
193
209
  */
194
210
  asyncUpdate: boolean;
195
211
  /**
@@ -246,8 +262,19 @@ export declare class EntityManagement extends EntityManagement_base {
246
262
  * @public
247
263
  */
248
264
  datasourceConfig: DatasourceConfiguration;
265
+ /**
266
+ * @internal
267
+ */
249
268
  formUiSchema: UiSchema;
269
+ /**
270
+ * Enables you to supply a schema to configure an insert form.
271
+ * @public
272
+ */
250
273
  createFormUiSchema: UiSchema;
274
+ /**
275
+ * Enables you to supply a schema to configure an update form.
276
+ * @public
277
+ */
251
278
  updateFormUiSchema: UiSchema;
252
279
  /**
253
280
  * The name of the resource in the backend to interact with when dispatching actions from the update/create modal
@@ -265,12 +292,12 @@ export declare class EntityManagement extends EntityManagement_base {
265
292
  * @remarks
266
293
  *
267
294
  * When the user attempts to initiate functionality such as deleting or editing an entity, the entity which will be deleted/edited is the one which is referenced by this variable
268
- * @public
295
+ * @internal
269
296
  */
270
297
  selectedEntity: Record<string, unknown>;
271
298
  /**
272
299
  * Disables the form while enabled to stop the user dispatching a large number of duplicate events
273
- * @public
300
+ * @internal
274
301
  */
275
302
  editedEntity: Record<string, unknown>;
276
303
  /**
@@ -278,17 +305,43 @@ export declare class EntityManagement extends EntityManagement_base {
278
305
  * @public
279
306
  */
280
307
  defaultEntityValues: Record<string, unknown>;
308
+ /**
309
+ * @internal
310
+ */
281
311
  submitting: boolean;
282
312
  /**
283
313
  * The type of form that is currently being displayed in the modal
314
+ * @internal
284
315
  */
285
316
  modalFormType: ModalFormType;
317
+ /**
318
+ * @internal
319
+ */
286
320
  editModalVisible: boolean;
287
- editModalVisibleChanged(): void;
321
+ private editModalVisibleChanged;
322
+ /**
323
+ * @internal
324
+ */
288
325
  editEntityModal: Modal;
326
+ /**
327
+ * Resizes columns to take available space
328
+ * @public
329
+ */
289
330
  sizeColumnsToFit: boolean;
331
+ /**
332
+ * Enables filter bar component
333
+ * @public
334
+ */
290
335
  enableFilterBar: boolean;
336
+ /**
337
+ * Hides edit button
338
+ * @public
339
+ */
291
340
  hideEdit: boolean;
341
+ /**
342
+ * Hides delete button
343
+ * @public
344
+ */
292
345
  hideDelete: boolean;
293
346
  /**
294
347
  * This attribute controls whether to enable the search-bar.
@@ -301,6 +354,10 @@ export declare class EntityManagement extends EntityManagement_base {
301
354
  * @public
302
355
  */
303
356
  headerCaseType: GridProCaseType;
357
+ /**
358
+ * Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid
359
+ * * @public
360
+ */
304
361
  searchBarConfig: AvailableOption[];
305
362
  /**
306
363
  * Determines where the modal dialog will appear on screen
@@ -323,27 +380,33 @@ export declare class EntityManagement extends EntityManagement_base {
323
380
  crudActionMenuName: string;
324
381
  /**
325
382
  * The Id of the crud buttons wrapper element
383
+ * @internal
326
384
  */
327
385
  crudMenuWrapper: any;
328
386
  /**
329
387
  * The helper function to determine the title of the modal form or button based on the action or type
330
388
  * @param actionOrType - The crud action or modal form type
389
+ * @internal
331
390
  */
332
391
  getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
333
392
  /**
334
393
  * Getter for the title of the modal form
394
+ * @internal
335
395
  */
336
396
  get modalFormTitle(): string;
337
397
  /**
338
398
  * Determines whether the button edit should be hidden in the column
399
+ * @internal
339
400
  */
340
401
  get shouldHideEditInColumn(): boolean;
341
402
  /**
342
403
  * Determines whether the button delete should be hidden in the column
404
+ * @internal
343
405
  */
344
406
  get shouldHideDeleteInColumn(): boolean;
345
407
  /**
346
408
  * Determines whether there is a selected entity
409
+ * @internal
347
410
  */
348
411
  get hasSelectedEntity(): boolean;
349
412
  /**
@@ -351,7 +414,7 @@ export declare class EntityManagement extends EntityManagement_base {
351
414
  *
352
415
  * @param slotName - The name of the slot to check.
353
416
  * @returns True if the slot has content, otherwise false.
354
- * @public
417
+ * @internal
355
418
  */
356
419
  hasContentInSlot(slotName: string): boolean;
357
420
  /**
@@ -359,6 +422,9 @@ export declare class EntityManagement extends EntityManagement_base {
359
422
  * @internal
360
423
  */
361
424
  connectedCallback(): Promise<void>;
425
+ /**
426
+ * @internal
427
+ */
362
428
  disconnectedCallback(): Promise<void>;
363
429
  /**
364
430
  * Gets the default searchBarConfig if the user has not created their own.
@@ -367,18 +433,15 @@ export declare class EntityManagement extends EntityManagement_base {
367
433
  private getDefaultSearchBarConfig;
368
434
  /**
369
435
  * Override the deepClone method to ensure that observable attributes are cloned
370
- * @public
436
+ * @internal
371
437
  */
372
438
  deepClone(): Node;
373
439
  /**
374
440
  * Event handler for when the user submits the action for the currently open form, either editing or adding the entity
375
441
  *
376
- * @param e - CustomEvent which contains the payload for the entity to submit to the backend
377
- *
378
- * Emits an event upon error
379
- * @public
442
+ * @internal
380
443
  */
381
- submitEntityChanges(e: CustomEvent): Promise<void>;
444
+ submitEntityChanges(): Promise<void>;
382
445
  /**
383
446
  * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
384
447
  *
@@ -400,15 +463,27 @@ export declare class EntityManagement extends EntityManagement_base {
400
463
  */
401
464
  editEntity({ detail }: CustomEvent): Promise<void>;
402
465
  private readEntity;
466
+ /**
467
+ * @internal
468
+ */
403
469
  closeModal(): void;
470
+ /**
471
+ * @internal
472
+ */
404
473
  get headerTempalate(): ViewTemplate<EntityManagement, any>;
474
+ /**
475
+ * @internal
476
+ */
405
477
  get isServerSideDatasource(): boolean;
478
+ /**
479
+ * @internal
480
+ */
406
481
  searchChanged(event: CustomEvent<Array<SelectedOption>>): void;
407
- searchBarReqServer(options: SelectedOption<string>[]): void;
408
- searchBarDataserver(options: SelectedOption<string>[]): void;
409
- requestChanged(e: CustomEvent<string>): void;
410
- criteriaChanged(e: CustomEvent<string>): void;
411
- submitFailureNotification(e: CustomEvent): void;
482
+ private searchBarReqServer;
483
+ private searchBarDataserver;
484
+ private requestChanged;
485
+ private criteriaChanged;
486
+ private submitFailureNotification;
412
487
  private submitErrorHandler;
413
488
  /**
414
489
  * Handler for deleting the entity. Added as an event listener on the class when receiving the `delete-entity` event.
@@ -417,11 +492,15 @@ export declare class EntityManagement extends EntityManagement_base {
417
492
  * @internal
418
493
  */
419
494
  deleteEntity(e: CustomEvent): Promise<void>;
495
+ /**
496
+ * @internal
497
+ */
420
498
  confirmDelete(): Promise<void>;
421
499
  private showDeleteConfirmation;
422
500
  /**
423
501
  * Emit the CRUD event for the selected entity
424
502
  * @param action - the action to emit
503
+ * @internal
425
504
  */
426
505
  emitCrud(action: 'create' | 'edit' | 'delete'): void;
427
506
  /**
@@ -442,6 +521,7 @@ export declare class EntityManagement extends EntityManagement_base {
442
521
  private generateCrudActionsMenu;
443
522
  /**
444
523
  * The event handler for when the selection changes in the grid.
524
+ * @internal
445
525
  */
446
526
  selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
447
527
  }
@@ -506,10 +586,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
506
586
  readonly scrollHeight: number;
507
587
  scrollLeft: number;
508
588
  scrollTop: number;
509
- /**
510
- * GridOptions to be passed down from application
511
- * @public
512
- */
513
589
  readonly scrollWidth: number;
514
590
  readonly shadowRoot: ShadowRoot;
515
591
  slot: string;
@@ -521,6 +597,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
521
597
  getAttribute(qualifiedName: string): string;
522
598
  getAttributeNS(namespace: string, localName: string): string;
523
599
  getAttributeNames(): string[];
600
+ /**
601
+ * GridOptions to be passed down from application
602
+ * @public
603
+ */
524
604
  getAttributeNode(qualifiedName: string): Attr;
525
605
  getAttributeNodeNS(namespace: string, localName: string): Attr;
526
606
  getBoundingClientRect(): DOMRect;
@@ -567,10 +647,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
567
647
  readonly lastChild: ChildNode;
568
648
  readonly nextSibling: ChildNode;
569
649
  readonly nodeName: string;
570
- /**
571
- * Determines the style of the buttons
572
- * @public
573
- */
574
650
  readonly nodeType: number;
575
651
  nodeValue: string;
576
652
  readonly parentElement: HTMLElement;
@@ -585,7 +661,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
585
661
  insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
586
662
  isDefaultNamespace(namespace: string): boolean;
587
663
  isEqualNode(otherNode: Node): boolean;
588
- isSameNode(otherNode: Node): boolean;
664
+ isSameNode(otherNode: Node): boolean; /**
665
+ * Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid
666
+ * * @public
667
+ */
589
668
  lookupNamespaceURI(prefix: string): string;
590
669
  lookupPrefix(namespace: string): string;
591
670
  normalize(): void;
@@ -606,6 +685,11 @@ declare const EntityManagement_base: (new (...args: any[]) => {
606
685
  readonly ELEMENT_NODE: number;
607
686
  readonly ENTITY_NODE: number;
608
687
  readonly ENTITY_REFERENCE_NODE: number;
688
+ /**
689
+ * The helper function to determine the title of the modal form or button based on the action or type
690
+ * @param actionOrType - The crud action or modal form type
691
+ * @internal
692
+ */
609
693
  readonly NOTATION_NODE: number;
610
694
  readonly PROCESSING_INSTRUCTION_NODE: number;
611
695
  readonly TEXT_NODE: number;
@@ -623,7 +707,10 @@ declare const EntityManagement_base: (new (...args: any[]) => {
623
707
  ariaExpanded: string;
624
708
  ariaHasPopup: string;
625
709
  ariaHidden: string;
626
- ariaInvalid: string;
710
+ ariaInvalid: string; /**
711
+ * Getter for the title of the modal form
712
+ * @internal
713
+ */
627
714
  ariaKeyShortcuts: string;
628
715
  ariaLabel: string;
629
716
  ariaLevel: string;
@@ -717,7 +804,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
717
804
  onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
718
805
  onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
719
806
  onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
720
- onload: (this: GlobalEventHandlers, ev: Event) => any;
807
+ onload: (this: GlobalEventHandlers, ev: Event) => any; /**
808
+ * Updates the reference to the current entity stored in the class. Added as an event listener on the class when receiving the `rowSelected` event.
809
+ *
810
+ * @param e - CustomEvent which contains data about the selected entity. If the row is not selected then the reference will be set to an empty object.
811
+ * @internal
812
+ */
721
813
  onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
722
814
  onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
723
815
  onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
@@ -729,7 +821,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
729
821
  onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
730
822
  onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
731
823
  onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
732
- onpause: (this: GlobalEventHandlers, ev: Event) => any;
824
+ onpause: (this: GlobalEventHandlers, ev: Event) => any; /**
825
+ * Opens the model to edit an entity. Added as an event listener on the class when receiving the `edit-entity` event.
826
+ *
827
+ * @param e - CustomEvent where `e.detail` is the entity to edit.
828
+ * @internal
829
+ */
733
830
  onplay: (this: GlobalEventHandlers, ev: Event) => any;
734
831
  onplaying: (this: GlobalEventHandlers, ev: Event) => any;
735
832
  onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
@@ -751,6 +848,9 @@ declare const EntityManagement_base: (new (...args: any[]) => {
751
848
  onselect: (this: GlobalEventHandlers, ev: Event) => any;
752
849
  onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
753
850
  onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
851
+ /**
852
+ * @internal
853
+ */
754
854
  onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
755
855
  onstalled: (this: GlobalEventHandlers, ev: Event) => any;
756
856
  onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.createFormUiSchema property
6
6
 
7
+ Enables you to supply a schema to configure an insert form.
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.enableFilterBar property
6
6
 
7
+ Enables filter bar component
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## EntityManagement.entityLabel property
6
6
 
7
- Label for the entity which has usages such as being shown in the title of the modal wen editing the entity
7
+ Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications
8
8
 
9
9
  **Signature:**
10
10
 
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.hideDelete property
6
6
 
7
+ Hides delete button
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.hideEdit property
6
6
 
7
+ Hides edit button
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -36,76 +36,36 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
36
36
 
37
37
  | Property | Modifiers | Type | Description |
38
38
  | --- | --- | --- | --- |
39
- | [asyncAdd](./foundation-entity-management.entitymanagement.asyncadd.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*add\* transactions |
40
- | [asyncRemove](./foundation-entity-management.entitymanagement.asyncremove.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*remove\* transactions |
41
- | [asyncUpdate](./foundation-entity-management.entitymanagement.asyncupdate.md) | | boolean | Whether to use the <code>applyTransactionAsync</code> function for \*update\* transactions |
42
39
  | [columns](./foundation-entity-management.entitymanagement.columns.md) | | ColDef\[\] | Array which holds the column definitions. |
43
- | [connect](./foundation-entity-management.entitymanagement.connect.md) | <code>protected</code> | Connect | DI connect object which is used to interact with the backend. |
44
40
  | [createEvent](./foundation-entity-management.entitymanagement.createevent.md) | | string | Name of the event handler on the Genesis server which handles creating an entity |
45
- | [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md) | | UiSchema | |
41
+ | [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md) | | UiSchema | Enables you to supply a schema to configure an insert form. |
46
42
  | [crudActionMenuName](./foundation-entity-management.entitymanagement.crudactionmenuname.md) | | string | The label of the crud action menu |
47
43
  | [crudMenuPosition](./foundation-entity-management.entitymanagement.crudmenuposition.md) | | CrudMenuPosition | Determines where the buttons will appear |
48
44
  | [crudMenuStyle](./foundation-entity-management.entitymanagement.crudmenustyle.md) | | ActionsMenuStyle | Determines the style of the buttons |
49
- | [crudMenuWrapper](./foundation-entity-management.entitymanagement.crudmenuwrapper.md) | | any | The Id of the crud buttons wrapper element |
50
45
  | [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md) | | [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md) | The configuration which is used when interacting with the resource on the backend |
51
46
  | [datasourceType](./foundation-entity-management.entitymanagement.datasourcetype.md) | | DatasourceType | If set to 'server' it will enable Server-Side Row Model and use <code>grid-pro-server-side-datasource</code> for the grid of the <code>entity-list</code> sub-component. By default <code>grid-pro-client-side-datasource</code> will be used. |
52
47
  | [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md) | | Record&lt;string, unknown&gt; | The default values to populate the form with when the user is adding an entity |
53
48
  | [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md) | | string | Name of the event handler on the Genesis server which handles deleting the entity |
54
- | [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md) | | Record&lt;string, unknown&gt; | Disables the form while enabled to stop the user dispatching a large number of duplicate events |
55
- | [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md) | | Modal | |
56
- | [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md) | | boolean | |
57
49
  | [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md) | | boolean | If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef |
58
- | [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) | | boolean | |
50
+ | [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) | | boolean | Enables filter bar component |
59
51
  | [enableRowFlashing](./foundation-entity-management.entitymanagement.enablerowflashing.md) | | boolean | If true, will enable row flashing for all rows for <code>add</code> transactions |
60
52
  | [enableSearchBar](./foundation-entity-management.entitymanagement.enablesearchbar.md) | | boolean | This attribute controls whether to enable the search-bar. |
61
- | [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md) | | string | Label for the entity which has usages such as being shown in the title of the modal wen editing the entity |
53
+ | [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md) | | string | Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications |
62
54
  | [formRenderers](./foundation-entity-management.entitymanagement.formrenderers.md) | | RendererEntry\[\] | Array with renderers used by foundation-forms |
63
- | [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) | | UiSchema | |
64
55
  | [gridOptions](./foundation-entity-management.entitymanagement.gridoptions.md) | | GridOptions | GridOptions to be passed down from application |
65
- | [hasSelectedEntity](./foundation-entity-management.entitymanagement.hasselectedentity.md) | <code>readonly</code> | boolean | Determines whether there is a selected entity |
66
56
  | [headerCaseType](./foundation-entity-management.entitymanagement.headercasetype.md) | | GridProCaseType | The case type to use for the header names. If not set, the default CONSTANT\_CASE will be used. |
67
- | [headerTempalate](./foundation-entity-management.entitymanagement.headertempalate.md) | <code>readonly</code> | import("@microsoft/fast-element").ViewTemplate&lt;[EntityManagement](./foundation-entity-management.entitymanagement.md)<!-- -->, any&gt; | |
68
- | [hideDelete](./foundation-entity-management.entitymanagement.hidedelete.md) | | boolean | |
69
- | [hideEdit](./foundation-entity-management.entitymanagement.hideedit.md) | | boolean | |
70
- | [isServerSideDatasource](./foundation-entity-management.entitymanagement.isserversidedatasource.md) | <code>readonly</code> | boolean | |
71
- | [modalFormTitle](./foundation-entity-management.entitymanagement.modalformtitle.md) | <code>readonly</code> | string | Getter for the title of the modal form |
72
- | [modalFormType](./foundation-entity-management.entitymanagement.modalformtype.md) | | ModalFormType | The type of form that is currently being displayed in the modal |
57
+ | [hideDelete](./foundation-entity-management.entitymanagement.hidedelete.md) | | boolean | Hides delete button |
58
+ | [hideEdit](./foundation-entity-management.entitymanagement.hideedit.md) | | boolean | Hides edit button |
73
59
  | [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md) | | 'centre' \| 'left' \| 'right' | Determines where the modal dialog will appear on screen |
74
60
  | [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md) | | string | This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it. |
75
61
  | [prefix](./foundation-entity-management.entitymanagement.prefix.md) | | string | Name of the design system prefix that will be used in renderers. |
76
- | [readEvent](./foundation-entity-management.entitymanagement.readevent.md) | | string | |
77
- | [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) | | (...args: any\[\]) =&gt; {} | |
78
- | [readonly](./foundation-entity-management.entitymanagement.readonly.md) | | boolean | |
62
+ | [readEvent](./foundation-entity-management.entitymanagement.readevent.md) | | string | Name of the request on the Genesis server which fetches data for the form, example usage could include fetching additional data that is not available in the grid but required for the selected entity |
63
+ | [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) | | (entity: any) =&gt; any | Similar to readEvent but allows to provide function that will be executed before opening the form and yields data to the form |
79
64
  | [resourceName](./foundation-entity-management.entitymanagement.resourcename.md) | | string | Name of the backend resource which contain the entities to manage |
80
65
  | [rowSelection](./foundation-entity-management.entitymanagement.rowselection.md) | | string | This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows. |
81
- | [searchBarConfig](./foundation-entity-management.entitymanagement.searchbarconfig.md) | | AvailableOption\[\] | |
82
- | [selectedEntity](./foundation-entity-management.entitymanagement.selectedentity.md) | | Record&lt;string, unknown&gt; | Reference to the currently selected entity from the grid. |
83
- | [shouldHideDeleteInColumn](./foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.md) | <code>readonly</code> | boolean | Determines whether the button delete should be hidden in the column |
84
- | [shouldHideEditInColumn](./foundation-entity-management.entitymanagement.shouldhideeditincolumn.md) | <code>readonly</code> | boolean | Determines whether the button edit should be hidden in the column |
85
- | [sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md) | | boolean | |
86
- | [submitting](./foundation-entity-management.entitymanagement.submitting.md) | | boolean | |
66
+ | [searchBarConfig](./foundation-entity-management.entitymanagement.searchbarconfig.md) | | AvailableOption\[\] | Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid \* |
67
+ | [sizeColumnsToFit](./foundation-entity-management.entitymanagement.sizecolumnstofit.md) | | boolean | Resizes columns to take available space |
87
68
  | [title](./foundation-entity-management.entitymanagement.title.md) | | string | Title of the grid |
88
69
  | [updateEvent](./foundation-entity-management.entitymanagement.updateevent.md) | | string | Name of the event handler on the Genesis server which handles updating the entity |
89
- | [updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md) | | UiSchema | |
90
-
91
- ## Methods
92
-
93
- | Method | Modifiers | Description |
94
- | --- | --- | --- |
95
- | [closeModal()](./foundation-entity-management.entitymanagement.closemodal.md) | | |
96
- | [confirmDelete()](./foundation-entity-management.entitymanagement.confirmdelete.md) | | |
97
- | [criteriaChanged(e)](./foundation-entity-management.entitymanagement.criteriachanged.md) | | |
98
- | [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) | | Override the deepClone method to ensure that observable attributes are cloned |
99
- | [disconnectedCallback()](./foundation-entity-management.entitymanagement.disconnectedcallback.md) | | |
100
- | [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) | | |
101
- | [emitCrud(action)](./foundation-entity-management.entitymanagement.emitcrud.md) | | Emit the CRUD event for the selected entity |
102
- | [getTitleBasedOnActionOrType(actionOrType)](./foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md) | | The helper function to determine the title of the modal form or button based on the action or type |
103
- | [hasContentInSlot(slotName)](./foundation-entity-management.entitymanagement.hascontentinslot.md) | | Checks if a slot contains any content. |
104
- | [requestChanged(e)](./foundation-entity-management.entitymanagement.requestchanged.md) | | |
105
- | [searchBarDataserver(options)](./foundation-entity-management.entitymanagement.searchbardataserver.md) | | |
106
- | [searchBarReqServer(options)](./foundation-entity-management.entitymanagement.searchbarreqserver.md) | | |
107
- | [searchChanged(event)](./foundation-entity-management.entitymanagement.searchchanged.md) | | |
108
- | [selectionChanged(event)](./foundation-entity-management.entitymanagement.selectionchanged.md) | | The event handler for when the selection changes in the grid. |
109
- | [submitEntityChanges(e)](./foundation-entity-management.entitymanagement.submitentitychanges.md) | | Event handler for when the user submits the action for the currently open form, either editing or adding the entity |
110
- | [submitFailureNotification(e)](./foundation-entity-management.entitymanagement.submitfailurenotification.md) | | |
70
+ | [updateFormUiSchema](./foundation-entity-management.entitymanagement.updateformuischema.md) | | UiSchema | Enables you to supply a schema to configure an update form. |
111
71
 
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.readEvent property
6
6
 
7
+ Name of the request on the Genesis server which fetches data for the form, example usage could include fetching additional data that is not available in the grid but required for the selected entity
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,8 +4,10 @@
4
4
 
5
5
  ## EntityManagement.readEventFn property
6
6
 
7
+ Similar to readEvent but allows to provide function that will be executed before opening the form and yields data to the form
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
10
- readEventFn: (...args: any[]) => {};
12
+ readEventFn: (entity: any) => any;
11
13
  ```
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.searchBarConfig property
6
6
 
7
+ Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid \*
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.sizeColumnsToFit property
6
6
 
7
+ Resizes columns to take available space
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
@@ -4,6 +4,8 @@
4
4
 
5
5
  ## EntityManagement.updateFormUiSchema property
6
6
 
7
+ Enables you to supply a schema to configure an update form.
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript