Adds support for iconPosition on element styles (options are Top, Bottom, Left).

Author: simonbrowndotje

changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v4.2.0 (unreleased)
+
+- structurizr-dsl: Adds support for `iconPosition` on element styles (options are `Top`, `Bottom`, `Left`).
+
 ## v4.1.0 (28th May 2025)
 
 - structurizr-client: Fixes https://github.com/structurizr/java/issues/413 (Cannot push to main branch, when branch feature is activated).

gradle.properties

@@ -5,4 +5,4 @@ signing.secretKeyRingFile=/some/path
 ossrhUsername=username
 ossrhPassword=password
 
-version=4.1.0
+version=4.2.0

structurizr-core/src/main/java/com/structurizr/view/ElementStyle.java

@@ -41,6 +41,9 @@ public final class ElementStyle extends AbstractStyle {
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private String icon;
 
+    @JsonInclude(value = JsonInclude.Include.NON_NULL)
+    private IconPosition iconPosition;
+
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Border border;
 
@@ -290,6 +293,24 @@ public ElementStyle icon(String icon) {
         return this;
     }
 
+    /**
+     * Gets the icon position to use when rendering the element.
+     *
+     * @return  an IconPosition, or null if not specified
+     */
+    public IconPosition getIconPosition() {
+        return iconPosition;
+    }
+
+    public void setIconPosition(IconPosition iconPosition) {
+        this.iconPosition = iconPosition;
+    }
+
+    public ElementStyle iconPosition(IconPosition iconPosition) {
+        setIconPosition(iconPosition);
+        return this;
+    }
+
     /**
      * Gets the border used when rendering the element.
      *

structurizr-core/src/main/java/com/structurizr/view/IconPosition.java

@@ -0,0 +1,9 @@
+package com.structurizr.view;
+
+public enum IconPosition {
+
+    Top,
+    Bottom,
+    Left
+
+}

structurizr-dsl/src/main/java/com/structurizr/dsl/ElementStyleDslContext.java

@@ -27,6 +27,7 @@ protected String[] getPermittedTokens() {
         return new String[] {
                 StructurizrDslTokens.ELEMENT_STYLE_SHAPE_TOKEN,
                 StructurizrDslTokens.ELEMENT_STYLE_ICON_TOKEN,
+                StructurizrDslTokens.ELEMENT_STYLE_ICON_POSITION_TOKEN,
                 StructurizrDslTokens.ELEMENT_STYLE_WIDTH_TOKEN,
                 StructurizrDslTokens.ELEMENT_STYLE_HEIGHT_TOKEN,
                 StructurizrDslTokens.ELEMENT_STYLE_BACKGROUND_TOKEN,

structurizr-dsl/src/main/java/com/structurizr/dsl/ElementStyleParser.java

@@ -5,6 +5,7 @@
 import com.structurizr.util.StringUtils;
 import com.structurizr.view.Border;
 import com.structurizr.view.ElementStyle;
+import com.structurizr.view.IconPosition;
 import com.structurizr.view.Shape;
 
 import java.io.File;
@@ -318,4 +319,33 @@ void parseIcon(ElementStyleDslContext context, Tokens tokens, boolean restricted
         }
     }
 
+    void parseIconPosition(ElementStyleDslContext context, Tokens tokens) {
+        Map<String, IconPosition> iconPositions = new HashMap<>();
+        String iconPositionsAsString = "";
+        for (IconPosition iconPosition : IconPosition.values()) {
+            iconPositions.put(iconPosition.toString().toLowerCase(), iconPosition);
+            iconPositionsAsString += iconPosition;
+            iconPositionsAsString += "|";
+        }
+        iconPositionsAsString = iconPositionsAsString.substring(0, iconPositionsAsString.length()-1);
+
+        ElementStyle style = context.getStyle();
+
+        if (tokens.hasMoreThan(FIRST_PROPERTY_INDEX)) {
+            throw new RuntimeException("Too many tokens, expected: iconPosition <" + iconPositionsAsString + ">");
+        }
+
+        if (tokens.includes(FIRST_PROPERTY_INDEX)) {
+            String iconPosition = tokens.get(1).toLowerCase();
+
+            if (iconPositions.containsKey(iconPosition)) {
+                style.setIconPosition(iconPositions.get(iconPosition));
+            } else {
+                throw new RuntimeException("The icon position \"" + iconPosition + "\" is not valid");
+            }
+        } else {
+            throw new RuntimeException("Expected: iconPosition <" + iconPositionsAsString + ">");
+        }
+    }
+
 }

structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java

@@ -834,6 +834,9 @@ void parse(List<String> lines, File dslFile, boolean fragment, boolean includeIn
                     } else if (ELEMENT_STYLE_ICON_TOKEN.equalsIgnoreCase(firstToken) && inContext(ElementStyleDslContext.class)) {
                         new ElementStyleParser().parseIcon(getContext(ElementStyleDslContext.class), tokens, restricted);
 
+                    } else if (ELEMENT_STYLE_ICON_POSITION_TOKEN.equalsIgnoreCase(firstToken) && inContext(ElementStyleDslContext.class)) {
+                        new ElementStyleParser().parseIconPosition(getContext(ElementStyleDslContext.class), tokens);
+
                     } else if (RELATIONSHIP_STYLE_TOKEN.equalsIgnoreCase(firstToken) && inContext(StylesDslContext.class)) {
                         RelationshipStyle relationshipStyle = new RelationshipStyleParser().parseRelationshipStyle(getContext(), tokens.withoutContextStartToken());
                         startContext(new RelationshipStyleDslContext(relationshipStyle));

structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslTokens.java

@@ -71,6 +71,7 @@ class StructurizrDslTokens {
     static final String ELEMENT_STYLE_COLOUR_TOKEN = "colour";
     static final String ELEMENT_STYLE_COLOR_TOKEN = "color";
     static final String ELEMENT_STYLE_ICON_TOKEN = "icon";
+    static final String ELEMENT_STYLE_ICON_POSITION_TOKEN = "iconPosition";
     static final String ELEMENT_STYLE_OPACITY_TOKEN = "opacity";
     static final String ELEMENT_STYLE_BORDER_TOKEN = "border";
     static final String ELEMENT_STYLE_FONT_SIZE_TOKEN = "fontSize";

structurizr-dsl/src/test/java/com/structurizr/dsl/ElementStyleParserTests.java

@@ -2,6 +2,7 @@
 
 import com.structurizr.view.Border;
 import com.structurizr.view.ElementStyle;
+import com.structurizr.view.IconPosition;
 import com.structurizr.view.Shape;
 import org.junit.jupiter.api.Test;
 
@@ -543,4 +544,40 @@ void test_parseIcon_SetsTheIconFromAFile() {
         assertTrue(elementStyle.getIcon().startsWith("data:image/png;base64,"));
     }
 
+    @Test
+    void test_parseIconPosition_ThrowsAnException_WhenThereAreTooManyTokens() {
+        try {
+            parser.parseIconPosition(elementStyleDslContext(), tokens("iconPosition", "top", "extra"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("Too many tokens, expected: iconPosition <Top|Bottom|Left>", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseIconPosition_ThrowsAnException_WhenTheShapeIsMissing() {
+        try {
+            parser.parseIconPosition(elementStyleDslContext(), tokens("iconPosition"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("Expected: iconPosition <Top|Bottom|Left>", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseIconPosition_ThrowsAnException_WhenTheShapeIsNotValid() {
+        try {
+            parser.parseIconPosition(elementStyleDslContext(), tokens("iconPosition", "right"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("The icon position \"right\" is not valid", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseIconPosition_SetsTheIconPosition() {
+        parser.parseIconPosition(elementStyleDslContext(), tokens("iconPosition", "top"));
+        assertEquals(IconPosition.Top, elementStyle.getIconPosition());
+    }
+
 }