customizations: {
style: {
customCSSUrl: "https://cdn.jsdelivr.net/gh/thoughtspot/custom-css-demo/css-variables.css", // location of your stylesheet
// To apply overrides for your stylesheet in this init, provide variable values
customCSS: {
variables: {
"--ts-var-button--secondary-background": "#F0EBFF",
"--ts-var-button--secondary--hover-background": "#E3D9FC",
"--ts-var-root-background": "#F7F5FF",
},
},
},
},Customize CSS
Table of Contents
ThoughtSpot provides advanced style customization capabilities with the custom CSS framework. The custom CSS feature allows you to override the default styles, color schemes, design elements, and typography of ThoughtSpot elements to match the look and feel of your host application.
Before you begin🔗
-
Identify the UI elements you want to customize.
-
For best results, you can combine the customization settings in the UI and custom CSS. However, note that CSS overrides take precedence over the style customization settings configured in the UI. For more information, see Scope of customization.
-
Try it out in the Visual Embed Playground. The Visual Embed Playground now includes the Apply Styles checkbox, using which you can try out the variables and rules.
To preview the CSS settings:-
Go to Develop > Visual Embed > Playground.
-
Select the embed element. For example, Full App.
-
Select Apply custom styles.
The following code text appears in the
initfunction and is highlighted in the code panel: -
Change the style specifications for any variable. For a complete list of variables, see Supported variables.
-
Click
Run.
-
Get started with customize styles🔗
To get started with CSS customization:
-
Make sure your deployments are upgraded to support Visual Embed SDK version 1.17.0 or later.
-
To load fonts, images, favicons, and stylesheets from an external source, your instance must allow a CSP override. You must explicitly set the source URLs as trusted domains on the Security Settings page in the Develop tab.
-
In the
initcall, add the location of the stylesheet in thecustomCssUrlattribute.The following example sets an external stylesheet hosted on GitHub and uses
jsDelivrto provide the CSS overrides to ThoughtSpot:init({ thoughtSpotHost: "https://<hostname>:<port>", customizations: { style: { customCSSUrl: "https://cdn.jsdelivr.net/gh/thoughtspot/custom-css-demo/css-variables.css" } } });- customCssUrl
-
String. CSS file path. You can copy the default CSS file provided by ThoughtSpot to create your own. This file includes the most common variables and rules that ThoughtSpot supports. You can apply the overrides within the given file and load it, or add style specifications directly in the code.
- customCSS
-
The custom CSS object that defines variables and rules to override style specifications in the code.
The following example shows how to override the style specifications for secondary buttons using
customCSSvariables directly in theinitcode:
init({ thoughtSpotHost: "https://<hostname>:<port>", customizations: { style: { customCSS: { variables: { "--ts-var-button--secondary-background": "#F0EBFF", "--ts-var-button--secondary--hover-background": "#E3D9FC", "--ts-var-root-background": "#F7F5FF", }, } } } }); -
If custom fonts are required, import fonts.
The following example shows how to add a custom font in the CSS file:
@font-face { font-family: 'YourFontName'; /Name of the font/ src: url('http://domain.example/fonts/font.ttf'); /source URL of the font/ } :root { --ts-var-root-font-family: 'YourFontName'; }The following example shows how to add a custom font and apply it to CSS variables in the
customCSSobject:init({ thoughtSpotHost: "https://<hostname>:<port>", customizations: { style: { customCSS: { variables: { "--ts-var-root-font-family": 'YourFontName', }, rules_UNSTABLE: { '@font-face': { 'font-family': 'YourFontName', 'src': "url('http://domain.example/fonts/font.ttf')" } } } } } }); -
After you modify the styles, reload your application and verify the changes.
Supported variables🔗
ThoughtSpot provides a default CSS file containing the most common variables and rules supported in a given release version. You can apply the overrides within the given file or add variable definitions directly in the code.
Application-wide settings🔗
The following example shows the supported variables:
| Variable | Description |
|---|---|
| Background color of the Liveboard, visualization, Search, and Answer pages. |
| Color of the text on application pages. |
| Font type for the text on application pages. |
| Text transformation specification for UI elements in the app. |
Navigation panel🔗
The navigation panel appears at the top of the application page.
| Variable | Description |
|---|---|
| Background color of the top navigation panel. |
| Font color of the top navigation panel. |
| Background color of the Search data button. |
| Color of the text on the Search data button. |
| Font of the text on the Search data button. |
Search bar and Data panel🔗
The search bar element that allows passing search tokens.
| Variable | Description |
|---|---|
| Font color of the text in the Search bar. |
| Font of the text in the Search bar. |
| Font style of the text in the Search bar. |
| Background color of the search bar. |
| Background color of the search suggestions panel. |
| Background color of the navigation panel that allows you to undo, redo, and reset search operations. |
| Background color of the navigation help text that appears at the bottom of the search suggestions panel. |
| Background color of the search suggestion block on hover. |
| Font color of the text in the search suggestion panel. |
| Font color of the sub-text that appears below the keyword in the search suggestion panel. |
| Background color of the data panel. |
| Background color of the vertical panel on the right side of the Answer page, which includes the options to edit charts and tables. |
The following figure shows customizable search page components:
Chart switcher🔗
The chart switcher icon 
appears on search results and Answer pages:
| Variable | Description |
|---|---|
| Background color of the chart switcher on search results and Answer pages. |
| Background color of the currently selected chart type in the chart switcher. |
Button elements🔗
ThoughtSpot application contains the following types of button elements:
-
Primary
Buttons that trigger an action for an entire page or a container. For example, the Go button on the search bar.NoteThe Go button appears as a primary button when the search bar is in the focused state. If you click outside the search bar or execute the search query to load search results, the Go button changes to a secondary button.
Primary buttons may contain text, text with an icon, or just an icon.
-
Secondary
Buttons that trigger additional actions. For example, More menu
and Edit buttons on a Liveboard. -
Tertiary
Buttons that are less prominent and trigger independent actions for sub-tasks on a page. For example,the Undo, Redo, Reset buttons on the Search page.
Use the following variables to customize buttons.
| Variable | Element type | Description |
|---|---|---|
| Main button | Border-radius of main buttons. |
| Small buttons | Border-radius of small buttons such as secondary buttons. |
| Primary button | Font color of the text on primary buttons. For example, the primary buttons on Liveboard, Answer, Data workspace, SpotIQ, or Home page. |
| Primary button | Font family specification for the text on primary buttons. |
| Primary button | Background color of the primary buttons. For example, the primary buttons such as Pin and Save. |
| Primary button | Background color of the primary buttons on hover. |
| Secondary button | Font color of the text on the secondary buttons. |
| Secondary button | Font family specification for the text on the secondary buttons. |
| Secondary button | Background color of the secondary buttons. |
| Secondary button | Background color of the secondary button on hover. |
| Tertiary button | Font color of the tertiary button. For example, the Undo, Redo, and Reset buttons on the Search page. |
| Tertiary button | Background color of the tertiary button. |
| Tertiary button | Background color of the tertiary button when a user hovers over these buttons. |
Visualization and Answer charts🔗
Use the following variables to customize UI elements on Liveboard, visualization and Answer pages.
Tiles on Liveboard, title and description of charts and tables
You can customize the look and feel of the visualization tiles on a Liveboard, styles for title and description text of charts and tables.
| Variable | Description |
|---|---|
| Font color of the title text of a visualization or Answer. |
| Font family specification for the title text of a visualization/Answer. |
| Text transformation specification for visualization and Answer titles. |
| Font color of the description text and subtitle of a visualization or Answer. |
| Font family specification of description text and subtitle of a visualization or Answer. |
| Text transformation specification for description text and subtitle of a visualization or Answer. |
| Border-radius for the visualization tiles and header panel on a Liveboard. |
| Box shadow property for the visualization tiles and header panel on a Liveboard. |
| Background color of the visualization tiles and header panel on a Liveboard. |
| Background color of the legend on a visualization or Answer. |
Chart selection widget
The chart selection widget appears on clicking the Change visualization icon 
on the Answer page or when you open a visualization in the Edit mode.
Use the following variables to customize the background color of the chart type icons:
| Variable | Description |
|---|---|
| Background color of the selected chart type on the chart selection widget. |
| Background color of the chart type element when a user hovers over a chart type on the chart selection widget. |
Filter chips on visualization and Answer pages
Filter chips appear on the Liveboard, Answer, and visualization pages if filters are applied on charts and tables. You can use the following variables to customize the look and feel of filter chips.
| Variable | Description |
|---|---|
| Border-radius of filter chips. |
| Shadow effect for filter chips. |
| Background color of filter chips. |
| Font color of the filter label when a filter chip is selected |
| Background color of the filter chips when selected. |
| Font color of the text on filter chips when hovered over. |
| Background color of filter chips on hover. |
| Font color of the text on filter chips. |
| Font family specification for the text on filter chips. |
Axis title and labels on charts
Use the following variables to customize X-axis and Y-axis titles and labels on charts.
| Variable | Description |
|---|---|
| Font color of axis title on charts. |
| Font family specification for the X and Y axis title text. |
| Font color of the X and Y axis labels. |
| Font family specification for X and Y axis labels . |
Menu elements🔗
CSS Variables for More menu , contextual menu, and dropdown selection panels.
The More menu appears on Liveboard, visualization, answers, SpotIQ, and several other application pages. Contextual menu appears when you right-click on a data point on a chart or table.
| Variable | Description |
|---|---|
| Font color of the menu items. |
| Background color of menu panels. |
| Font family specification for the menu items. |
| Text capitalization specification for the menu items. |
| Background color for menu items on hover. |
Dialogs🔗
CSS variables for dialogs that prompt the user to select an option or enter information. For example, the Liveboard pin dialog that appears on clicking Pin on the Search results or Answer page, the Show underlying data dialog that appears on clicking Show underlying data on a Liveboard visualization or Answer.
| Variable | Description |
|---|---|
| Background color of the dialogs. |
| Font color of the body text displayed on dialogs. |
| Background color of the header text on dialogs. |
| Font color of the header text on dialogs. |
| Background color of the footer area on dialogs. |
UI element reference🔗
The following figures show the customizable elements and example definitions for CSS variables.
Search page🔗
Liveboard page🔗
Sample CSS file with variable definitions🔗
:root {
/******** App ********/
/* Application-wide background, app-wide text color, app-wide font, app-wide text transform */
--ts-var-root-background: #FFFFFF;
--ts-var-root-color: #1D232F;
--ts-var-root-font-family: Roboto,Helvetica,Arial,sans-serif;
--ts-var-root-text-transform: initial;
/******** Top navigation panel ********/
--ts-var-nav-color: #F7F5FF;
--ts-var-nav-background: #163772;
--ts-var-search-data-button-background": #EAEDF2;
--ts-var-search-data-button-font-color: var(--ts-var-root-color);
--ts-var-search-data-button-font-family: var(--ts-var-root-font-family);
/******** Search bar, search navigation and auto-suggestion panels ********/
--ts-var-search-bar-text-font-color: #1D232F;
--ts-var-search-bar-text-font-family: var(--ts-var-root-font-family);
--ts-var-search-bar-text-font-style: normal;
--ts-var-search-bar-background: #000000;
--ts-var-search-auto-complete-background: #EAEDF2;
--ts-var-search-navigation-button-background: #EAEDF2;
--ts-var-search-bar-navigation-help-text-background: #EAEDF2;
--ts-var-search-bar-auto-complete-hover-background: #C0C6CF;
--ts-var-search-auto-complete-font-color: #000000;
--ts-var-search-auto-complete-subtext-font-color: #1D232F;
/******** Data and edit panels on Answer page ********/
--ts-var-answer-data-panel-background-color: initial;
--ts-var-answer-edit-panel-background-color: #1D232F;
/******** Buttons ********/
/* Application-wide button design for main buttons. For example, Search data*/
--ts-var-button-border-radius: 5px;
/* Application-wide button design for smaller buttons. For example, buttons with share and favorite icons*/
--ts-var-button--icon-border-radius: 5px;
/* Primary buttons: For example, the Go button in the search bar, the Pin and Save buttons on the Search page */
--ts-var-button--primary-color: #ffffff;
--ts-var-button--primary-background: #2770EF;
--ts-var-button--primary--hover-background: #1D232F;
--ts-var-button--primary--font-family: var(--ts-var-root-font-family);
/* Secondary buttons. For example, the Edit and Explore buttons on the Liveboard page*/
--ts-var-button--secondary-color: #1D232F;
--ts-var-button--secondary-background: #EAEDF2;
--ts-var-button--secondary--hover-background: #2359B6;
--ts-var-button--secondary--font-family: var(--ts-var-root-font-family);
/* Tertiary buttons. For example, the Undo, Redo buttons on the Search page*/
--ts-var-button--tertiary-color: #1D232F;
--ts-var-button--tertiary-background: #FFFFFF;
--ts-var-button--tertiary--hover-background: #EAEDF2;
/******** Visualizations and answers ********/
/* Title text */
--ts-var-viz-title-color: #2359B6;
--ts-var-viz-title-font-family: Roboto,Helvetica,Arial,sans-serif;
--ts-var-viz-title-text-transform: Capitalize;
/* Subtitle and description text */
--ts-var-viz-description-color: #C26232;
--ts-var-viz-description-font-family: var(--ts-var-root-font-family);
--ts-var-viz-description-text-transform: Capitalize;
/* Visualization tile customization on the Liveboard page*/
--ts-var-viz-border-radius: 15px;
--ts-var-viz-box-shadow: 1px 2px 5px #888888;
--ts-var-viz-background: #F2F7FF;
--ts-var-viz-legend-hover-background: #ABC7F9;
/* Chart selection widget on answers and visualization pages*/
--ts-var-answer-chart-select-background: #ABC7F9;
--ts-var-answer-chart-hover-background: #CEDCF5;
/* Filter chips on answers and visualization pages */
--ts-var-chip-border-radius: 25pt;
--ts-var-chip-title-font-family: var(--ts-var-root-font-family);
--ts-var-chip-box-shadow: initial;
--ts-var-chip-background: #B5ECF2;
--ts-var-chip-color: var(--ts-var-root-color);
--ts-var-chip--hover-background: #48D1E0;
--ts-var-chip--hover-color: var(--ts-var-root-color);
--ts-var-chip--active-background: #369FAA;
--ts-var-chip--active-color: #ffffff;
/* Axis titles and labels*/
--ts-var-axis-title-color: var(--ts-var-root-color);
--ts-var-axis-title-font-family: var(--ts-var-root-font-family);
--ts-var-axis-data-label-color: #163772;
--ts-var-axis-data-label-font-family: var(--ts-var-root-font-family);
/******** Menu components ********/
--ts-var-menu-color: var(--ts-var-root-color);
--ts-var-menu-background: #DEE8FA;
--ts-var-menu-font-family: var(--ts-var-root-font-family);
--ts-var-menu-text-transform: capitalize;
--ts-var-menu--hover-background: #ABC7F9;
/**** Dialogs and modals that prompt users to perform an action or enter information *******/
--ts-var-dialog-body-background: var(--ts-var-root-background);
--ts-var-dialog-body-color: var(--ts-var-root-color);
--ts-var-dialog-header-background: #CEDCF5;
--ts-var-dialog-header-color: var(--ts-var-root-color);
--ts-var-dialog-footer-background: var(--ts-var-root-background);
}Customize elements using rules🔗
The rules option in the customCSS object allows you to apply style overrides to UI components and elements that cannot be customized using the variables provided by ThoughtSpot, inline in your code without having to include a separate stylesheet file.
|
Warning
|
While the |
When defining rules for style overrides:
-
Use the correct style class and values in your rule statements.
To find the class name of an element:-
Right-click on the element and select Inspect.
-
Note the style class for the selected element in the Elements tab on the Developer Tools console.
-
-
Add the
_UNSTABLEsuffix to therulesproperty.
A rule is defined in a JSON notation for styles, rather than direct CSS.
rules_UNSTABLE: {
'{selector1}' : {
"{css-property-name}" : "{value}",
"{css-property-name2}" : "{value}"
},
'{selector2}'...
}The selector to get the appropriate element may only require a simple standard id or class identifier like .classname or #idName, or it may need to be a complex CSS selector involving bracket syntax and other complex operators. The following are examples of selector syntax to try in the rules section to isolate a particular element:
-
'.bk-filter-option' -
'[id="bk-filter-option"]' -
'[class="sage-search-bar-module__undoRedoResetWrapper"]' -
'[class="className"] [aria-colid="6"]' -
'[data-tour-id="chart-switcher-id"]'
The following example shows how to change the background color of the All Tags and All Authors dropdowns on the Home page of the ThoughtSpot application.
init({
thoughtSpotHost: "https://<hostname>:<port>",
customizations: {
style: {
customCSS: {
rules_UNSTABLE: {
'[data-testid="select-dropdown-header"]':{
"background-color":"#ABC7F9"
}
}
},
},
},
});The following figure shows the style override applied using the preceding code example:
Customize text strings🔗
The following example shows how to customize text strings on the ThoughtSpot pages:
init({
thoughtSpotHost: "https://<hostname>:<port>",
customizations: {
content: {
strings: {
"Liveboard": "Dashboard",
"Edit": "Modify",
"Show underlying data": "Show source data",
"SpotIQ": "Insights",
"Monitor": "Alerts",
"Worksheets": "Data model"
}
}
}
});|
Note
|
Customization of user-defined text strings such as object names, title or description text is not supported. |
Customize icons🔗
You can customize the icons on a ThoughtSpot page using an icon sprite SVG file and load it from a Web server or CDN.
To override icons:
-
Create a sprite SVG file for icons.
-
Specify the icon ID that you want to override in the
<symbol>element. To find the ID of the ThoughtSpot icon:-
Go to the ThoughtSpot page.
-
Right-click on the icon and select Inspect.
-
Copy the ID for the selected icon and add it as the
<symbol id>.<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="width:0;height:0;visibility:hidden;"> <defs/> <symbol id="rd-icon-user" viewBox="0 0 18 18"> <path d="m8.5 4.5c0 1.38071-1.11929 2.5-2.5 2.5s-2.5-1.11929-2.5-2.5 1.11929-2.5 2.5-2.5 2.5 1.11929 2.5 2.5z"/> <path d="m15.5 3.375h-2v2.625h-2.5v2h2.5v2.375h2v-2.375h2.5v-2h-2.5z"/> <path d="m1 12.875c0-2.7614 2.23858-5 5-5s5 2.2386 5 5v3.125h-10z"/> </symbol> </svg>
-
-
To add another icon, add another
<symbol>element and specify the icon ID. -
Host the icon sprite SVG file on a Web server.
-
To override the icons on the ThoughtSpot page, specify the icon sprite URL in the
iconSpriteURLproperty of thecustomziationscode in Visual Embed SDK.customizations: { iconSpriteUrl: "https://cdn.jsdelivr.net/gh/thoughtspot/custom-css-demo/icon-override1.svg" } -
Ensure that the icon sprite URL is added as a trusted domain on the Develop > Security Settings page. For more information, see Security settings.
-
Load the application page and check the icon.