Skip to main content

ClientConfig

Overview​

The ClientConfig interface extends PublicConfig and represents the public-facing (non sensitive) configuration values available to the High Velocity front-end app.

Configuration values are grouped by vendor or functionality. A configuration group can be retrieved from Config() or useConfig() hook by its top level key name, for example, google or localeConfig.

Attributes​

locale​

type: string


The app's current request locale.

PublicConfig​

Attributes​

localeConfig​

type: object


The locale configuration object.

localeConfig.defaultLocale​

type: string


The default locale for the implementation.

localeConfig.locales​

type: string[]


An array of supported locales for the implementation.

builderIO (optional)​

type: object


The Builder.io configuration object.

Only required if the implementation uses Builder.io CMS vendor package.

builderIO.apiKey​

type: string


The API key for Builder.io.

environment​

type: object


The environment configuration object.

environment.siteRoot​

type: string


The root URL of the site.

google (optional)​

type: object


The Google configuration object.

Only required if the implementation uses Google features.

google.gtmID​

type: string


The Google Tag Manager ID.

google.ytAPIKey​

type: string


The YouTube API key.

paypal (optional)​

type: object


The PayPal configuration object.

Only required if the implementation uses PayPal payment vendor package.

paypal.clientId​

type: string


The client ID for PayPal.