Skip to content

Add support for CSS and/or JS customization. #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for CSS and/or JS customization. #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion src/main/java/com/structurizr/lite/web/AbstractController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@
import com.structurizr.lite.component.workspace.WorkspaceComponent;
import com.structurizr.lite.util.RandomGuidGenerator;
import com.structurizr.lite.util.Version;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.ModelAttribute;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Base64;
import java.util.TimeZone;

Expand All @@ -20,6 +25,10 @@ public abstract class AbstractController {
private static final String REFERER_POLICY_HEADER = "Referrer-Policy";
private static final String REFERER_POLICY_VALUE = "strict-origin-when-cross-origin";
private static final String SCRIPT_NONCE_ATTRIBUTE = "scriptNonce";

private static final Log log = LogFactory.getLog(AbstractController.class);
private static final String STRUCTURIZR_CSS_FILENAME = "structurizr.css";
private static final String STRUCTURIZR_JS_FILENAME = "structurizr.js";

protected WorkspaceComponent workspaceComponent;

Expand Down Expand Up @@ -48,6 +57,24 @@ protected void addCommonAttributes(ModelMap model, String pageTitle, boolean sho
model.addAttribute("showHeader", showHeaderAndFooter);
model.addAttribute("showFooter", showHeaderAndFooter);
model.addAttribute("version", new Version());

File cssFile = new File(Configuration.getInstance().getDataDirectory(), STRUCTURIZR_CSS_FILENAME);
if (cssFile.exists()) {
try {
model.addAttribute("css", Files.readString(cssFile.toPath()));
} catch (IOException ioe) {
log.warn(ioe);
}
}

File jsFile = new File(Configuration.getInstance().getDataDirectory(), STRUCTURIZR_JS_FILENAME);
if (jsFile.exists()) {
try {
model.addAttribute("js", Files.readString(jsFile.toPath()));
} catch (IOException ioe) {
log.warn(ioe);
}
}

if (pageTitle == null || pageTitle.trim().length() == 0) {
model.addAttribute("pageTitle", "Structurizr");
Expand Down Expand Up @@ -81,4 +108,4 @@ public void setWorkspaceComponent(WorkspaceComponent workspaceComponent) {
this.workspaceComponent = workspaceComponent;
}

}
}
17 changes: 17 additions & 0 deletions src/main/webapp/WEB-INF/fragments/prelude.jspf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@
<link href="${structurizrConfiguration.cdnUrl}/css/bootstrap-3.3.7.min.css" rel="stylesheet" media="screen" />
<link href="${structurizrConfiguration.cdnUrl}/css/bootstrap-theme-3.3.7.min.css" rel="stylesheet" media="screen" />
<link href="${structurizrConfiguration.cdnUrl}/css/structurizr.css" rel="stylesheet" media="screen" />

<c:if test="${not empty css}">
<style>
${css}
</style>
</c:if>

<c:if test="${embed eq true}">
<link href="${structurizrConfiguration.cdnUrl}/css/structurizr-embed.css" rel="stylesheet" media="screen" />
</c:if>
Expand All @@ -29,6 +36,16 @@
<script type="text/javascript" src="${structurizrConfiguration.cdnUrl}/js/structurizr${structurizrConfiguration.versionSuffix}.js"></script>
<script type="text/javascript" src="${structurizrConfiguration.cdnUrl}/js/structurizr-ui${structurizrConfiguration.versionSuffix}.js"></script>
<script type="text/javascript" src="${structurizrConfiguration.cdnUrl}/js/structurizr-util${structurizrConfiguration.versionSuffix}.js"></script>

<c:if test="${not empty js}">
<script nonce="${scriptNonce}">
try {
${js}
} catch (err) {
console.error(err);
}
</script>
</c:if>
</head>

<script nonce="${scriptNonce}">
Expand Down