This documentation is for WSO2 API Manager 1.9.1 View documentation for the latest release.
Adding a new API Store Theme - API Manager 1.9.1 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

A theme consists of UI elements such as logos, images, copyrights messages, landing page text, background colors etc. WSO2 API Store comes with a default theme. 

The folder structure of the API Store themes

The default theme of the API Store is called Fancy. You find it inside the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes/fancy folder. If you do not have access to the file system, download the default theme from here

The easiest way to create a new theme is to copy the files of an existing theme to a folder by the name of your new theme, and do the modifications you want to the files inside it. All themes have the same folder structure as shown below:

You can add a new theme as a main theme or a sub theme.

  • A main theme is saved inside the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes folder
  • A sub theme is saved inside the  <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes/<folder of the main theme>/subthemes folder. 

Because a sub theme is saved inside a main theme, it needs to contain only the files that are different from the main theme. Any file you add inside the sub theme will override the corresponding files in the main theme. The rest of the files will be inherited from the main theme. 

Let's see how to create a new theme and set it to the API Store: 

Writing a sub theme of the main theme

Because a main theme already has most of the UIs and the syntax and logic of Jaggery code defined, in a typical scenario, you do not have to implement a theme from scratch. Rather, you just add in your edits as a sub theme of the existing main theme as given below:

  1. Download the default main theme from here, unzip it and rename the folder according to the name of your new theme (e.g., ancient). Let's call this folder the <THEME_HOME>.
  2. To change the logo of the API Store, replace the logo.png  file inside the <THEME_HOME>/images folder with this logo (or anything else of your choice.)
  3. To change the copyrights note in the footer, open the  <THEME_HOME>/templates/page/base/template.jag  file using a text editor, search for the word "Copyright"  and change the text. For example, let's add our company name as "copyright", "&copy; Copyright 2011 &ndash; 2014 My Company."
  4. To change the header's background color, open the <THEME_HOME>/css/styles-layout.css file using a text editor and add the following CSS rule to the end of the file. It changes the header color.

    .header{    
        background:#7e3330;
    }
  5. As you plan to upload this as a sub theme of the default main theme, delete all the files in your <THEME_HOME> folder except the ones that you edited. The rest of the files will be automatically applied from the main theme.

Setting the new theme as the default theme

You can set your new theme as the default theme in two ways:

Saving directly in the file system

If you have access to the file system, do the following:

  1. Save the <THEME_HOME> folder inside the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes/fancy/subthemes folder. This will make your new theme a sub theme of fancy. 
  2. Open the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/conf/site.json file and add the following code to it. It specifies the base theme as fancy, which is overridden by the sub theme ancient.

    "theme" : {
            "base" : "fancy",
            "subtheme" : "ancient"
    }
  3. Open the API Store and note the new theme applied to it.

Uploading through the Admin Dashboard

If you do not have access to the file system, you can upload the theme through the Admin Dashboard Web application as shown below: 

  1. Go inside the <THEME_HOME> folder, select all the folders inside it and right click to archive all the selected files and folders together. Then rename the archive files to ancient.zip.
  2. Log in to WSO2 Admin Dashboard Web application using the URL https://<Server Host>:9443/admin-dashboard.
    For example, if you are a WSO2 Cloud user and want to upload a new theme, log in to the URL api.cloud.wso2.com/admin-dashboard with the user name as email@domain with the @ in the email replaced by a dot (e.g., john.gmail.com@MyCompany). 
  3. Click the Upload Tenant Theme menu and upload your zip file.
  4. Open the API Store and note the new theme applied to it.

Adding the new theme to the Themes menu

Once you are done modifying the new theme, add it to the Themes menu in the API Store along with a thumbnail image as follows:

  1. Open the <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes/fancy/templates/user/login/template.jag file and find the HTML table that defines the theme thumbnails.
  2. Add a new row under the <table> element with the following code. It adds thumb-ancient.png as the thumbnail image of our theme. Be sure save the image in the ...fancy/images folder.

    <td>
        <div class="thumbnail <% if(jagg.getUserTheme().base == "fancy" && jagg.getUserTheme().subtheme == "ancient") { %>currentTheme<% } %>">
            <a data-theme="fancy" data-subtheme="ancient" class="badge themeLabel" onclick="applyTheme(this)">
                 <img src="<%=jagg.getAbsoluteUrl(jagg.getThemeFile("images/thumb-ancient.png"))%>" />
                 <br /><div class="themeName">Ancient</div>
             </a>
        </div>
    </td>
  • No labels