Edit the Theme Manifest: Example

In NetSuite theme development, editing the manifest.json file is crucial for customizing your theme effectively. This file, located in the theme's Workspace directory, lists all HTML templates, Sass, and assets. It's necessary to adjust this file when you add new components to your theme.

What is a Theme Manifest?

The theme manifest is a JSON file essential for compiling resources for an active theme in NetSuite. It contains metadata about the theme and lists information about templates, Sass, skins, assets, and paths. Understanding each section aids in effective theme customization and deployment.

Theme Metadata

The metadata section includes fields like name, vendor, type, target, version, and description. These fields provide critical information about the theme, such as its name and version, and are automatically updated when you deploy using the gulp theme:deploy command.

How to Manage Overrides

Overrides are included if you introduce extension overrides. Using Gulp.js commands, any HTML or Sass overrides are automatically included in this file, ensuring they are correctly integrated into the theme.

Templates Section

The templates object lists HTML template files associated with different applications. You must manually add new template files here to ensure they are included in your custom theme.

Sass Management

In the sass object, you list all entry points and Sass files to load. Ensure any new Sass files are declared in an order that follows the Sass hierarchy to maintain theme integrity.

Customizing Skins

The skins array is populated when you run theme commands. For example, creating seasonal skins like winter and spring involves adding skin preset files, which are then automatically included in the manifest. You can edit these presets to provide custom names for display in the SMT Theme Skin Manager.

Assets and Record Paths

The assets object manages image and font paths. Ensure any new asset files added for customizations are included here. Finally, the manifest concludes with record paths defining the theme's location and activation identifiers.

Who This Affects

Developers: Those involved in theme development and customization.
Site Managers: Responsible for maintaining site aesthetics using themes.

Key Takeaways

The manifest.json file is crucial for managing a NetSuite theme's components.
Always update the manifest to include new templates, Sass files, and assets.
Skins and assets require careful management to reflect theme customizations effectively.
Deploy correctly with Gulp.js commands to ensure all changes are integrated.

Frequently Asked Questions (4)

How can I create different selectable skins for a theme in NetSuite?

To create different selectable skins for a theme, you can place individual skin preset files in your theme's Skins directory, naming them according to your desired categories (e.g., winter_skin.json, spring_skin.json, etc.). These will then be included in your theme's manifest.json.

Do I need to run a specific command for the theme developer tools to update my manifest.json with skins?

Yes, you need to run the `theme gulp:local` command. This command automatically updates your theme's manifest.json file to include the skins located in your Skins directory.

Can I change the display names for skins in the SMT Theme Skin Manager later?

Yes, you can change the display names by editing the `name` property in the manifest.json file for each skin. This will update how the skins are displayed in the SMT Theme Skin Manager.

Where should I store the skin preset files for my theme?

Skin preset files should be stored in the Skins directory within your theme. This allows the theme developer tools to recognize and include them in the theme's manifest.json file.