Customize the My Account UI¶

This section explains how we can customize the theming of My Account application.

Change the default theme to dark mode¶

A customized version of the default theme in the Semantic UI LESS package has been used to achieve the look and feel of the My Account.

For information on the Semantic UI theming, see Semantic UI documentation.

Before you begin¶

1. Check out the corresponding identity apps source code from the identity-apps repository. You can check out the v1.6.191 tag since v1.6.191 of identity-apps is used in IS 6.1.0.

   $ git fetch --all --tags --prune
   $ git checkout tags/v1.6.191 -b feature-dark-theme-demo

2. Navigate to the modules/theme/src/themes folder within identity-apps. All the theme global variable overrides can be found in the modules/theme/src/themes/default/globals/site.variables file. For the full set of variables, see the original theme variables file.

Follow the steps given below to further customize My Account application.

Step 1: Change the primary color of My Account¶

In order to change the primary color of the My account application, the variables in site.variables need to be overridden.

1. Add a new color under the site colors and name it. In this example it is named, facebookBlue.

   /*-------------------
       Site Colors
   --------------------*/
   
   @facebookBlue     : #2d88ff;

2. Now change the primary color variable.

   /*-------------------
       Brand Colors
   --------------------*/
   
   @primaryColor        : @facebookBlue;

3. Next, change the page background color and text color. In this example, the background color is changed from white to dark gray and the default text color is changed to a lighter shade. Add a new variable under the brand colors. It is called globalBackgroundColor in this example.

   /*-------------------
       Brand Colors
   --------------------*/
   
   @globalBackgroundColor: #18191a;

4. Override the @pageBackground variable.

   /*-------------------
           Page
   --------------------*/
   
   @pageBackground      : @globalBackgroundColor;
   @textColor           : #e4e6eb;

5. Build the theme module by running the following command and check the results reflected on the dev server.

   # from inside `modules/theme`
   $ npm run build

   The response should be similar to the screenshot given below.

   

   As seen in the image above, the background color of the header, footer, side navigation, and content cards can be changed.

6. In order to change the header and footer background colors, add a new variable to the modules/theme/src/themes/default/globals/site.variables file and give it a value as shown below. This variable is named globalForegroundColor in this example.

   /*-------------------
       Brand Colors
   --------------------*/
   
   @globalForegroundColor: #1d2630;

7. Add the color defined in the step above (globalForegroundColor) to the Menu, App Header, and App Footer sections in the modules/theme/src/themes/default/collections/menu.variables file as shown below.

   /*******************************
               Menu
   *******************************/
   
   @background: @globalForegroundColor;

   /*-------------------
       App Header
   --------------------*/
   
   @appHeaderBackground: @globalForegroundColor;

   /*-------------------
       App Footer
   --------------------*/
   
   @appFooterBackground: @globalForegroundColor;

8. Change the side panel background in the modules/theme/src/themes/default/collections/menu.overrides file.

   .ui.vertical.menu {
       &.side-panel {
           background: @globalBackgroundColor;
   
           // Other styles
       }
   }

9. Modify the content card background color in the modules/theme/src/themes/default/views/card.variables file.

   @background: @globalForegroundColor;

The status can be checked by rebuilding the theme module. The changes should be reflected on the running dev server in no time. A sample screen of the new theme is shown below.

Step 2: Change the branding¶

Now that the styling is complete, the following steps explain how the product branding can be changed.

Change the product logo¶

Follow below instructions to override the existing WSO2 IS logo using CSS.

1. Download an icon from any of the providers such as Flaticon.com. In this example, owl.svg was the downloaded icon. Now add it to the modules/theme/src/themes/default/assets/images folder.

2. Open the modules/theme/src/theme-core/definitions/globals/product.less file and replace the existing styles in the .product-logo class with the following.

   .product-title {
       .product-logo {
           width: 25px;
           height: 25px;
           vertical-align: text-top;
           margin-right: 5px;
           background: url(assets/images/owl.svg) no-repeat;
           background-size: auto;
   
           svg {
               display: none;
           }
       }
   
       // Other styles
   }

Step 3: Deploy changes in the web app¶

The final step of the process is the deployment. Follow the sequence of steps listed below to deploy the changes performed in the previous steps.

1. Build the theme module.

   # from inside modules/theme
   $ npm run build

2. Copy the default theme folder available inside modules/theme/dist/lib/themes/ directory into the <IS_HOME>/repository/deployment/server/webapps/myaccount/libs/themes/ folder.

   Warning

   Make sure that you keep a backup of the original theme folder.

3. Open the home.jsp file available in the <IS_HOME>/repository/deployment/server/webapps/myaccount/ directory and search for the HTML link tag referencing the minified theme file. The filename will be in the format of theme.<hash>.min.css. Find the filename of the newly build minified theme file and replace it in the HTML link tag.

   <link href="/myaccount/libs/themes/default/theme.<hash>.min.css" rel="stylesheet" type="text/css"/>

The final theme should look similar to the following.