@communities-webruntime/services
Version:
If you would like to run Lightning Web Runtime without the CLI, we expose some of our programmatic APIs available in Node.js. If you're looking for the CLI documentation [you can find that here](https://www.npmjs.com/package/@communities-webruntime/cli).
76 lines • 2.23 kB
TypeScript
/** @hidden */
/**
* Copyright (c) 2019, salesforce.com, inc.
* All rights reserved.
* SPDX-License-Identifier: MIT
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
*/
export default interface WebruntimeContextConfig {
/**
* The template module directory
*/
templateDir: string;
/**
* Source directory, used to compute the template version key
*/
srcDir?: string;
/**
* The base path to use in branding properties URL values
*/
basePath?: string;
/**
* The Web Runtime labels configuration file path (i.e. labels.json), or representative json object
*/
labels?: string;
/**
* The Web Runtime locales configuration file path (i.e. locales.json), or representative json object
*/
locales?: string;
/**
* The default locale configured during application initialization
*/
defaultLocale?: string;
/**
* Directory where partials are stored to be used in templates, or representative json object
*/
partials?: string;
/**
* The Web Runtime routes configuration file path (i.e. routes.json), or representative json object
*/
routes?: string;
/**
* The Web Runtime themes configuration file path (i.e. theme.json), or representative json object
*/
theme?: string;
/**
* The template version key, default to a hash of the src folder
*/
versionKey?: string;
/**
* The Web Runtime views directory, or representative json object keyed by view name
*/
views?: string;
/**
* Determines whether the context is design mode
*/
isDesignMode?: boolean;
/**
* Determines whether the site is loading in Mobile App or Browser;
*/
isMobileAppMode?: boolean;
/**
* Whether Locker vNext is enabled, default true if not specified
*/
isLockerEnabled?: boolean;
/**
* Overrides for app behaviours
*/
appOverrides?: appOverrides;
}
export interface appOverrides {
/**
* Inline module overrides for the base document
*/
inlineModuleOverrides?: Object;
}
//# sourceMappingURL=webruntime-context-config.d.ts.map