Skip to content

Branding

Dirigible allows you to change the branding of the platform.

Setting the brand information

There are two ways to do this:

Static

Configure the branding environment variables.

Dynamic

Use the setBrandingInfo function:

setBrandingInfo({
  name: "Dirigible",
  brand: "Eclipse",
  brandUrl: "https://www.dirigible.io/",
  icons: {
    favicon: "/services/web/platform-branding/images/favicon.ico",
  },
  logo: "/services/web/platform-branding/images/dirigible.svg",
  theme: "blimpkit-auto",
  prefix: "dirigible",
});
Parameter Description Required
name The product name no
brand The brand name no
brandUrl The brand/product URL no
icons Favicons no
icons.favicon Favicon in .ico format no
logo The brand/product logo no
theme The default theme ID no
prefix The prefix used for cookie and localStorage value keys no

Getting the brand information

const branding = getBrandingInfo();

The branding constant will be a reference to the global branding information object, which will have the same structure as the set function object parameter.

Initializing the branding

For standard shells, perspectives, views, and related components in Eclipse Dirigible, the PlatformAssets loader can be used directly.

Example:

<meta name="platform-links" category="ng-view" />

This approach ensures that all required assets for the specified category are automatically resolved and injected.

In a custom view, you must include those two files in your view. and make sure they are the first to load.

<script
  type="text/javascript"
  src="/services/js/platform-branding/branding.js"
></script>
<script
  type="text/javascript"
  src="/services/web/platform-core/utilities/view.js"
></script>