Merge pull request #418 from helsingborg-stad/chore/hero-typings

chore: hero typings
helsingborg-stad · Jul 5, 2024 · 5ed8d2e · 5ed8d2e
2 parents 1aad5e2 + f5df12b
commit 5ed8d2e
Showing 1 changed file with 30 additions and 2 deletions.
diff --git a/source/php/Component/Hero/hero.json b/source/php/Component/Hero/hero.json
@@ -23,7 +23,8 @@
         "contentApplyRoundedCorners": true,
         "contentApplyShadows": true,
         "buttonArgs": [],
-        "poster": false
+        "poster": false,
+        "overlay": ""
     },
     "description": {
         "image": "Background image",
@@ -48,7 +49,34 @@
         "contentApplyRoundedCorners": "Apply rounded corners to content if contentBackgroundColor is set.",
         "contentApplyShadows": "Apply shadows to content if contentBackgroundColor is set.",
         "buttonArgs": "Add a @button by passing @button component arguments. If button is treated as a link, all te text elements in the content gets wrapped with this link.",
-        "poster": "Poster image for the video"
+        "poster": "Poster image for the video",
+        "overlay": "Add an overlay over an image to make text more legible"
+    },
+    "types": {
+        "image": "string",
+        "imageFocus": "object",
+        "video": "string",
+        "size": "string",
+        "title": "string",
+        "byline": "string",
+        "paragraph": "string",
+        "stretch": "boolean",
+        "animation": "string",
+        "ariaLabel": "string",
+        "heroView": "string",
+        "customHeroData": "array",
+        "meta": "string",
+        "background": "string",
+        "textColor": "string",
+        "textAlignment": "string",
+        "contentBackgroundColor": "string",
+        "contentAlignmentVertical": "string",
+        "contentAlignmentHorizontal": "string",
+        "contentApplyRoundedCorners": "boolean",
+        "contentApplyShadows": "boolean",
+        "buttonArgs": "array",
+        "poster": "boolean",
+        "overlay": "string"
     },
     "view": "hero.blade.php",
     "dependency": {