refactor(map-overlay): missing property for MapOverlay Interface (#1114)

* refactor(map-overlay): missin property for MapOverlay Interface * refactor(mapOverlay): move from string to enum (media and mapoverlay class)
infra-geo-ouverte · Dec 20, 2023 · bb7f5e6 · bb7f5e6
1 parent 864271d
commit bb7f5e6
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 16 deletions.
diff --git a/src/app/pages/portal/map-overlay/map-overlay.enum.ts b/src/app/pages/portal/map-overlay/map-overlay.enum.ts
@@ -0,0 +1,11 @@
+export enum MapOverlayCssClass {
+  TopLeft = 'top-left',
+  CenterLeft = 'center-left',
+  BottomLeft = 'bottom-left',
+  TopCenter = 'top-center',
+  CenterCenter = 'center-center',
+  BottomCenter = 'bottom-center',
+  TopRight = 'top-right',
+  CenterRight = 'center-right',
+  BottoMRight = 'bottom-right'
+}
diff --git a/src/app/pages/portal/map-overlay/map-overlay.interface.ts b/src/app/pages/portal/map-overlay/map-overlay.interface.ts
@@ -1,20 +1,17 @@
+import { Media } from '@igo2/core';
+
+import { MapOverlayCssClass } from './map-overlay.enum';
+
 export interface MapOverlay {
-  media: Array<string> /* Media device to display the mapOverlay
-                            - options: mobile
-                                       tablet
-                                       desktop
-                            - default: desktop
-  cssClass: string;         /* Css class to define position of the element
-                            - options:  top-left
-                                        center-left
-                                        bottom-left
-                                        top-center
-                                        center-center
-                                        bottom-center
-                                        top-right
-                                        center-right
-                                        bottom-right
-  */;
+  /**
+   * Media device to display the mapOverlay
+   * Desktop is the default value.
+   */
+  media: Array<Media>;
+  /**
+   * Css class to define position of the element
+   */
+  cssClass: MapOverlayCssClass;
   fixed?: boolean; // Is element is fixed, won't be affect by animation, default to false
   link?: string; // Link to open when element is clicked
   imgSrc?: string; // source of the image to show