Customize home page experience
10.15.0.cl
Cloud (Latest)

Customize home page experience

Developers can customize the home page experience in full application embedding to show either the classic layout or the new modular home page.

In the classic (V1) experience, the home page has a static layout and does not support SDK modular customization settings.

In the V2 and V3 experience modes, you can customize the home page by specifying which modules are visible, their order, and the overall layout using configuration options available in the SDK.

Important
 The classic (V1) experience and V2 experience modes will be deprecated in an upcoming release in 2026. Therefore, ThoughtSpot recommends upgrading the UI experience of your full application embedding to the V3 experience.

Home page layout in the V3 experience🔗

In the V3 experience, the SDK provides the homePage attribute that allows you to choose the desired home page layout:

  • homePage: HomePage.ModularWithStylingChanges
    Enables the V3 modular home page experience with customizable components, styling options, and enhanced layout and visual elements.

  • homePage: HomePage.Modular
    Enables the basic modular home page experience with customizable components.

Customization settings for home page🔗

The following customization settings are available for the modular home page in the V2 and V3 experience modes.

SDK propertyClassic (V1) experienceV2 experienceV3 experience

hiddenHomepageModules
Controls the visibility of the modules on the home page.

x Not supported

✓ Supported

✓ Supported

reorderedHomepageModules
Arranges home page modules in the specified order.

x Not supported

✓ Supported

✓ Supported

homePageSearchBarMode
Sets the home page search bar experience to object search, Spotter/AI search, or none.

✓ Supported

✓ Supported

✓ Supported

isUnifiedSearchExperienceEnabled
Enables a combined interface with both Object Search and Natural Language Search. The unified experience is disabled by default.

✓ Supported

✓ Supported

✓ Supported

hideHomepageLeftNav
Hides the left navigation panel on the home page.

x Not supported

✓ Supported

✓ Supported

hiddenHomeLeftNavItems
Hides specific menu items of the left navigation panel on the home page.

x Not supported

✓ Supported

✓ Supported

Control the visibility of home page modules🔗

In the V2 and V3 experience modes, the home page includes sections such as Watchlist, Favorites, Library, Trending charts, and more. You can hide a specific section of the home page and reorder these modules as needed using the hiddenHomepageModules and reorderedHomepageModules configuration options in the embed SDK.

The hiddenHomepageModules and reorderedHomepageModules attributes support the following settings:

Allowed valuesClassic (V1) experienceV2 experienceV3 experience

HomepageModule.Favorite
For the Favorites module on the home page.

x Not supported

✓ Supported

✓ Supported

HomepageModule.Learning
For Learning section, which displays learning videos and resources on the home page.

x Not supported

✓ Supported

✓ Supported

HomepageModule.MyLibrary
For the Library section, which lists Answers and Liveboard objects.

x Not supported

✓ Supported

✓ Supported

HomepageModule.Search
For the search module on the home page.

x Not supported

✓ Supported

✓ Supported

HomepageModule.Trending
For the Trending section, which shows a list of trending Answers and Liveboards.

x Not supported

✓ Supported

✓ Supported

HomepageModule.Watchlist
For the Watchlist section, which is used for KPI monitoring.

x Not supported

✓ Supported

✓ Supported

Customize home page modules in the V3 experience🔗

The following example shows the configuration properties for customizing the home page modules:

import {
    AppEmbed, // Main class to embed the full ThoughtSpot app
    PrimaryNavbarVersion // Enum for V3 experience setting
    HomePage, // Enum for home page experience settings
    HomepageModule // Enum for home page modules
} from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed("#embed", {
    // Enable V3 navigation and home page experience
    discoveryExperience: {
        primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enables V3 experience
        homePage: HomePage.ModularWithStylingChanges, // Enables V3 home page
    },
    // Hide modules from the home page
    hiddenHomepageModules: [
        HomepageModule.Learning,
        HomepageModule.Trending
    ],
    // Custom order for visible modules
    reorderedHomepageModules: [
        HomepageModule.Search,
        HomepageModule.Favorite,
        HomepageModule.Watchlist,
        HomepageModule.MyLibrary
    ],
    //... other view configuration properties
});

Customize home page modules in the V2 experience🔗

The following example shows the configuration properties for customizing the home page modules in the V2 experience:

 import {
     AppEmbed, // Main class to embed the full ThoughtSpot app
     HomepageModule // Enum for home page modules
 } from '@thoughtspot/visual-embed-sdk';
 const embed = new AppEmbed("#embed", {
     // Enable V2 experience
     modularHomeExperience: true
     // Hide modules from the home page
     hiddenHomepageModules: [
         HomepageModule.Learning,
         HomepageModule.Trending
     ],
     // Set the order of home page modules
     reorderedHomepageModules: [
         HomepageModule.Search,
         HomepageModule.Favorite,
         HomepageModule.Watchlist,
         HomepageModule.MyLibrary
     ],
     //... Other view configuration properties
 });

Customize the search experience on home page🔗

You can set the search experience on the home page to function as an object search bar that allows finding popular objects, or as an AI search interface that allows natural language queries or Spotter sessions. You can also choose to hide it from the home page. To configure your preference, specify the following values in the homePageSearchBarMode attribute.

Search bar modeDescription

HomePageSearchBarMode.AI_ANSWER

Sets the natural language search bar that allows queries in natural language. If Spotter is enabled on your instance, you can use this setting to set the Spotter search bar on the home page.

HomePageSearchBarMode.OBJECT_SEARCH

Enables object search that allows users to find objects from the library.

HomePageSearchBarMode.NONE

Hides the search bar on the home page. Note that it only hides the Search bar on the Home page and doesn’t affect the Object Search bar visibility on the top navigation bar.

To hide the search bar on the home page, you can also use the homepageModule: HomepageModule.Search setting.

Note

If your instance is using the Classic (v1) experience and if the homePageSearchBarMode parameter does not set the search context defined in the attribute, set isUnifiedSearchExperienceEnabled to false.

Examples🔗

The following examples show code snippets to set the home page search bar mode to Spotter or AI search in different experience modes:

V3 experience
import {
    AppEmbed,
    PrimaryNavbarVersion // Enum for V3 navigation experience
    HomePage, // Enum for home page experience settings
    HomePageSearchBarMode // Import the enum for search bar mode options
} from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed("#embed", {
    discoveryExperience: {
        primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable v3 experience
        homePage: HomePage.ModularWithStylingChanges // Enable v3 home page experience
    },
    // Set the home page search bar to show the Spotter / AI search bar
    homePageSearchBarMode: HomePageSearchBarMode.AI_ANSWER
    // Other view configuration attributes
});
V2 experience
import {
    AppEmbed,
    HomePageSearchBarMode // Import the enum for search bar mode options
} from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed("#embed", {
    modularHomeExperience: true, // Enable v2 modular home page experience
    // Set the home page search bar to show the Spotter / AI search bar
    homePageSearchBarMode: HomePageSearchBarMode.AI_ANSWER
    // Other view configuration attributes
});
Classic (V1) experience
import {
    AppEmbed,
    HomePageSearchBarMode // Import the enum for search bar mode options
} from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed("#embed", {
    // Set the home page search bar to show the Spotter / AI search bar
    homePageSearchBarMode: HomePageSearchBarMode.aiAnswer,
    // Disable the unified search experience
    isUnifiedSearchExperienceEnabled: false,
    //... other embed view configuration attributes
});

Additional resources🔗

See also:

© 2025 ThoughtSpot Inc. All Rights Reserved.