feature: replaced strings with PrimeIcons in examples, interfaces and…

… tests
markuczy · Feb 21, 2024 · 1aef90f · 1aef90f
1 parent 6cecae9
commit 1aef90f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/...al-integration-angular/src/lib/core/components/button-dialog/button-dialog.component.html b/...al-integration-angular/src/lib/core/components/button-dialog/button-dialog.component.html
@@ -7,7 +7,7 @@
             pButton 
             *ngIf="dialogData.config.secondaryButtonIncluded"
             class="mx-2"
-            [icon]="dialogData.config.secondaryButtonDetails!.icon !== undefined ? dialogData.config.secondaryButtonDetails!.icon : ''"
+            icon="{{dialogData.config.secondaryButtonDetails!.icon !== undefined ? dialogData.config.secondaryButtonDetails!.icon : ''}}"
             (click)="secondaryButtonAction()"
             [label]="dialogData.config.secondaryButtonDetails!.key | translate:dialogData.config.secondaryButtonDetails?.parameters"
             [disabled]="secondaryButtonDisabled$ | async"
@@ -16,7 +16,7 @@
             id="buttonDialogPrimaryButton"
             pButton
             class="mx-2"
-            [icon]="dialogData.config.primaryButtonDetails!.icon !== undefined ? dialogData.config.primaryButtonDetails!.icon : ''"
+            icon="{{dialogData.config.primaryButtonDetails!.icon !== undefined ? dialogData.config.primaryButtonDetails!.icon : ''}}"
             (click)="primaryButtonAction()"
             [label]="dialogData.config.primaryButtonDetails!.key | translate:dialogData.config.primaryButtonDetails?.parameters"
             [disabled]="primaryButtonDisabled$ | async"

diff --git a/...integration-angular/src/lib/core/components/button-dialog/button-dialog.component.spec.ts b/...integration-angular/src/lib/core/components/button-dialog/button-dialog.component.spec.ts
@@ -9,6 +9,7 @@ import { ButtonDialogComponent } from './button-dialog.component'
 import { MockAuthModule } from '../../../mock-auth/mock-auth.module'
 import { ButtonDialogHarness, DivHarness } from '../../../../../testing'
 import { ButtonDialogConfig } from '../../../model/button-dialog'
+import { PrimeIcons } from 'primeng/api'
 
 @Component({
   template: `<ocx-button-dialog>
@@ -20,12 +21,12 @@ class TestBaseHostComponent {}
 const config: ButtonDialogConfig = {
   primaryButtonDetails: {
     key: 'inlineMain',
-    icon: 'pi pi-plus',
+    icon: PrimeIcons.PLUS,
   },
   secondaryButtonIncluded: true,
   secondaryButtonDetails: {
     key: 'inlineSide',
-    icon: 'pi pi-times',
+    icon: PrimeIcons.TIMES,
   },
 }
 

diff --git a/libs/portal-integration-angular/src/lib/model/button-dialog.ts b/libs/portal-integration-angular/src/lib/model/button-dialog.ts
@@ -1,4 +1,5 @@
 import { Type } from '@angular/core'
+import { PrimeIcons } from 'primeng/api'
 
 /**
  * Object describing details for button rendering containing key for translation, optional icon and optional parameters for translation
@@ -12,7 +13,7 @@ import { Type } from '@angular/core'
  * }
  * const buttonDetails: ButtonDialogButtonDetails = {
  *   key: 'MY_KEY',
- *   icon: 'pi pi-times',
+ *   icon: PrimeIcons.TIMES,
  *   parameters: {
  *     value: 'meeting'
  *   }
@@ -21,7 +22,7 @@ import { Type } from '@angular/core'
  */
 export interface ButtonDialogButtonDetails {
   key: string
-  icon?: string
+  icon?: PrimeIcons
   parameters?: Record<string, unknown>
 }
 

diff --git a/libs/portal-integration-angular/src/lib/services/portal-dialog.service.ts b/libs/portal-integration-angular/src/lib/services/portal-dialog.service.ts
@@ -6,6 +6,7 @@ import { DialogService, DynamicDialogConfig, DynamicDialogRef } from 'primeng/dy
 import { ButtonDialogComponent } from '../core/components/button-dialog/button-dialog.component'
 import { ButtonDialogButtonDetails, ButtonDialogData } from '../model/button-dialog'
 import { DialogMessageContentComponent } from '../core/components/button-dialog/dialog-message-content/dialog-message-content.component'
+import { PrimeIcons } from 'primeng/api'
 
 /**
  * Object containing key for translation with parameters object for translation
@@ -57,11 +58,11 @@ type TranslationKey = string | TranslationKeyWithParameters
  *       value = 'hello',
  *     },
  *   },
- *   icon: 'pi pi-question'
+ *   icon: PrimeIcons.QUESTION
  * }
  * ```
  */
-type DialogMessage = { message: TranslationKey; icon: string }
+type DialogMessage = { message: TranslationKey; icon: PrimeIcons }
 
 /**
  * Implement via component class to be displayed by {@link PortalDialogService.openDialog}
@@ -258,7 +259,7 @@ export class PortalDialogService {
    * // Welcome message with question mark icon
    * const dialogMessage = {
    *   key: 'WELCOME_MESSAGE',
-   *   icon: 'pi pi-question'
+   *   icon: PrimeIcons.QUESTION
    * }
    * this.portalDialogService.openDialog('TITLE_KEY', dialogMessage, 'OK_BUTTON').subscribe((stateOnClose) => {
    *   // operations when dialog has been closed
@@ -272,13 +273,13 @@ export class PortalDialogService {
    * // Ok button with check icon
    * const primaryButton = {
    *   key: 'OK_BUTTON',
-   *   icon: 'pi pi-check'
+   *   icon: PrimeIcons.CHECK
    * }
    *
    * // Refresh button with refresh icon
    * const secondaryButton = {
    *   key: 'REFRESH_BUTTON',
-   *   icon: 'pi pi-refresh'
+   *   icon: PrimeIcons.REFRESH
    * }
    *
    * this.portalDialogService.openDialog('TITLE_KEY', 'WELCOME_MESSAGE', primaryButton, secondaryButton).subscribe((stateOnClose) => {