skyuxconfig.json (SchemaStore) JSON Schema

Type	object
File match	`skyuxconfig.json` `skyuxconfig.*.json`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/skyuxconfig-json/latest.json
Source	https://raw.githubusercontent.com/blackbaud/skyux-config/4.x.x/skyuxconfig-schema.json

Validate with Lintel

npx @lintel/lintel check

Type: object

Properties

app object

Specifies configuration options for the local app when running skyux serve

6 nested properties

base string

Allows the base href to be set during skyux build.

title string

Controls the page title at the template level while waiting for the application to load.

port string

Configures a port for the skyux serve command to use. If no port is specified, skyux serve dynamically finds an available port.

externals object

Dynamically injects CSS and JavaScript files into SKY UX Host. You should have a specific use-case for an externals and they must be white-listed by the SKY UX team.

2 nested properties

css object

CSS files to inject

2 nested properties

before externalFileCSS[]

CSS files to inject before default SKY UX files.

after externalFileCSS[]

CSS files to inject after default SKY UX files.

js object

JS files to inject

2 nested properties

before externalFileJS[]

JS files to inject before default SKY UX files.

after externalFileJS[]

JS files to inject before default SKY UX files.

styles string[]

An array of CSS or SCSS files to be bundled with the SPA.

theming object

Specifies the theming capabilities of the application.

2 nested properties

theme string

Values: "default" "modern"

supportedThemes availableThemes[]

appSettings object

Specifies data that is available for reuse throughout the application.

auth boolean

Indicates whether the application requires an authenticated Blackbaud ID

codeCoverageThreshold string

Specifies the minimum required code coverage threshold.

Values: "none" "standard" "strict"

compileMode string

Specifies how to compile the project's code.

Default: "aot"

Values: "aot" "jit"

cssPath string

Specifies a path to reference CSS styles. This property is specific to the SKY UX docs site and is for internal Blackbaud use only.

enableIvy boolean

Enables or disables Angular's Ivy compiler during a build.

help object

Indicates whether to automatically include the help widget in the application to identify the current page and display relevant help content. This property is for internal Blackbaud use only.

host object

Blackbaud Only - Specifies configuration options for communication with SKY UX Host.

3 nested properties

bbCheckout object

Specifies bbCheckout options for the Host service.

1 nested properties

version string

Specifies the whitelisted version of bbCheckout to include.

Values: "2"

frameOptions object

Specifies frame options for the Host service.

4 nested properties

none boolean

Sets the frame options to none. Superseds all other frameOptions properties.

self boolean

Sets the frame options to self.

blackbaud boolean

Sets the frame options to common Blackbaud URLs

urls array

Sets the frame options to this list. Can be used in conjunction with the self and blackbaud properties.

url string

Specifies a base URL to pass information from skyux serve to the SKY UX Host.

Default: "https://host.nxt.blackbaud.com"

importPath string

Specifies a path to reference SKY UX components in Angular. This property is specific to the SKY UX docs site and is for internal Blackbaud use only.

dependenciesForTranspilation array

Specifies a list of package dependencies that are not ES5 compatible. Each package listed will be coverted to support SKY UX Builder's target environment.

mode string

Controls how much boilerplate code to generate automatically.

Default: "easy"

Values: "easy" "advanced"

moduleAliases object

Specifies module aliases to allow for custom module resolution.

name string

Specifies the name of the project when running in SKY UX Host. By default, SKY UX Builder uses the name property in the package.json file, minus the 'blackbaud-skyux-spa-' prefix.

omnibar object

Specifies an object to pass to the omnibar's load method. This property is for internal Blackbaud use only.

pacts array

PACTS

params object

Specifies a list of parameters that are allowed at runtime.

pipelineSettings object

Configuration options specific to pipeline configuration.

plugins array

Specifies plugins to expand on existing SKY UX Builder functionality and create new functionality.

redirects object

Specifies redirects for pages within an application using from : to pattern.

routes object

Allows you to use the omnibar but still define navigation items. This property is for internal Blackbaud use only.

2 nested properties

public array

Public routes.

referenced array

Referenced routes.

useHashRouting boolean

Allows your SPA to use Angular's hash location strategy.

skyuxModules array

The individual SKY UX modules that should be imported into the application. Use this property for performance optimization when your application only uses a small subset of SKY UX components.

librarySettings object

Container for controlling library settings

1 nested properties

whitelistedNonPeerDependencies string[]

Specifies package dependencies that are allowed to be added to a library's package.json dependencies object when a library is published.

testSettings object

Container for controlling test settings.

2 nested properties

e2e object

Test settings specific to the skyux e2e command.

1 nested properties

browserSet string

The named set of browsers to run against.

Values: "speedy"

unit object

Test settings specific to the skyux test command.

1 nested properties

browserSet string

The named set of browsers to run against.

Values: "speedy" "quirky" "paranoid"

Definitions

externalFileCSS object

url string

Fully qualified URL of the file.

integrity string

Subresource integrity string to include.

externalFileJS

availableThemes string