Skip to content

Commit 59cc173

Browse files
authored
Merge pull request #363 from thoughtspot/theme-builder
Theme builder
2 parents f35fdeb + 56b5568 commit 59cc173

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

modules/ROOT/pages/theme-builder.adoc

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
1-
= Theme builder
1+
= Theme builder [beta betaBackground]^Beta^
22
:toc: true
33
:toclevels: 2
44

55
:page-title: Theme builder
66
:page-pageid: theme-builder-doc
77
:page-description: Understanding how to use the theme builder
88

9-
Theme Builder[beta betaBackground]^Beta^ provides a graphical interface to explore the CSS customization options that are currently available for various ThoughtSpot components. You can try out these style customization options and get a preview of the desired look and feel before applying these changes to the ThoughtSpot components in your application environment.
9+
Theme Builder provides a graphical interface to explore the CSS customization options that are currently available for various ThoughtSpot components. You can try out these style customization options and get a preview of the desired look and feel before applying these changes to the ThoughtSpot components in your application environment.
1010

11-
In the current version, Theme Builder supports style customization options for embed components such as Liveboard, visualization, Search data page, and full ThoughtSpot app experience. The Theme Builder playground also provides an option to download and upload CSS variables with custom values in JSON format.
11+
In the current version, Theme Builder supports style customization options for embed components such as Liveboard, visualization, Search data page, Spotter and full ThoughtSpot app experience. The Theme Builder playground also provides an option to import and export CSS variables with custom values in JSON format.
1212

13-
To access Theme Builder, click *Live Playgrounds* > *Theme Builder* [beta betaBackground]^Beta^ on this documentation site, or go to link:https://developers.thoughtspot.com/docs/theme-builder[https://developers.thoughtspot.com/docs/theme-builder, window=_blank].
13+
//To access Theme Builder, go to *Develop* tab > *Customisations* and click *Theme Builder*.
14+
Click *Live Playgrounds* > *Theme Builder* on this documentation site, or go to link:https://developers.thoughtspot.com/docs/theme-builder[https://developers.thoughtspot.com/docs/theme-builder, window=_blank].
1415

1516
== Try out styles and load changes
1617

1718
To try out the customization options:
1819

19-
. Go to link:https://developers.thoughtspot.com/docs/theme-builder[Theme Builder].
20+
. Go to link:https://developers.thoughtspot.com/docs/theme-builder[*Theme Builder*, window=_blank].
2021
. Choose the desired embed component from the dropdown on the left panel.
2122
+
2223
[.bordered]
@@ -25,37 +26,37 @@ image::./images/tb-embed.png[Embed components menu]
2526

2627
. Select the UI element or property to customize. For instance, if you want to edit the background color of the context menu, then click the dropdown for the *Context Menu*. Click on the text box for *Background* and select your desired color.
2728
+
29+
If you want to the exact variable name of the element as in ThoughtSpot, hover over the name of the element in the left panel.
30+
+
2831
[.bordered]
2932
[.widthAuto]
3033
image::./images/tb-style-menu.png[Style components menu]
3134

32-
. To view the style customizations you just applied, click *Load Changes* in the top-right corner. +
33-
Alternatively, you can also choose *Realtime loading* checkbox in the top-right corner. If you choose this,
34-
the iframe refreshes automatically on each customization with your selected input.
35+
. You will see the style customizations you just applied in real time, as the iframe refreshes automatically on each customization with your selected input.
3536

36-
== Download CSS variables in JSON format
37+
== Export CSS variables in JSON format
3738

3839
To download a copy of the CSS variables in JSON:
3940

40-
. In the Theme Builder Playground, click *Save JSON*. +
41+
. In the Theme Builder Playground, click *Export JSON*. +
4142
. To copy the CSS variables, click *Copy JSON*.
42-
. To download the JSON to your local directory, click *Download*.
43+
. To download the JSON to your local directory, click *Export*.
4344

44-
The CSS variables in the JSON have default values. You can edit the JSON to add custom specifications as per your Organization's branding guidelines and upload the customized JSON to review the changes.
45+
You can use this exported JSON to implement the style in your embedded ThoughtSpot instance.
4546

46-
== Upload CSS variables with custom specifications
47+
== Import CSS variables with custom specifications
4748

4849
To upload CSS variables JSON:
4950

50-
. In the Theme Builder Playground, click *Upload JSON* on the bottom of the left panel.
51+
. In the Theme Builder Playground, click *Import JSON* on the bottom of the left panel.
5152
+
52-
The Upload JSON modal opens.
53+
The Import JSON modal opens.
5354
+
5455
[.bordered]
5556
[.widthAuto]
56-
image::./images/json.png[JSON button]
57-
. Paste the JSON with your custom specifications.
58-
. Click *Submit*. +
57+
image::./images/json.png[Import JSON button]
58+
. Paste the JSON with your custom specifications. Currently, the Theme builder supports only the JSON styling variables.
59+
. Click *Import*. +
5960
If there are no errors, a success message appears at the bottom left and the iframe refreshes with the applied JSON.
6061

6162
== Additional resources

static/doc-images/images/json.png

-60 KB
Loading
-10.4 KB
Loading
-3.61 KB
Loading

0 commit comments

Comments
 (0)