Developers
Start building
Themes/Theme SDK/Modules/settings

settings

Theme settings and the settings of a template's own section.

On this page
import { … } from '@poltura/theme-sdk/settings';

Hooks

NameWhat it is
useThemeSettingsThe theme settings in the page language, live while the merchant edits them in the customizer.
useTemplateSettingsThe settings of a template's own section, for an element placed elsewhere on the page.
useColorSchemeThe colour scheme the component renders in: the nearest section's or block's scheme, live while the merchant edits it.

Types

NameWhat it is
TemplateIdA page template of the storefront, such as product or layout.header.
TemplateSettingsThe settings of a template's own locked section, such as the product information of product.
SettingValueA stored setting value: text, a number, a switch, or a list or group of them.
ThemeSettingsThe theme's settings: the platform's groups typed, the theme's own keys as stored.
ColorSchemeOne of the theme's named colour schemes, as a section or block draws in it.
Last updated