dashy/docs/config-schema/dashy-config-properties-appconfig.md
2021-06-07 00:43:04 +01:00

6.3 KiB

Untitled object in Dashy Config Schema Schema

https://example.com/schemas/abstract#/properties/appConfig

Application configuration

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none dashy-config.schema.json*

appConfig Type

object (Details)

appConfig Properties

Property Type Required Nullable Defined by
backgroundImg string Optional cannot be null Dashy Config Schema
theme string Optional cannot be null Dashy Config Schema
enableFontAwesome boolean Optional cannot be null Dashy Config Schema
fontAwesomeKey string Optional cannot be null Dashy Config Schema
cssThemes array Optional cannot be null Dashy Config Schema
externalStyleSheet Multiple Optional cannot be null Dashy Config Schema
customCss string Optional cannot be null Dashy Config Schema

backgroundImg

A URL to an image asset to be displayed as background

backgroundImg

backgroundImg Type

string

theme

A theme to be applied by default on first load

theme

theme Type

string

theme Default Value

The default value is:

"Callisto"

enableFontAwesome

Should load font-awesome assets

enableFontAwesome

enableFontAwesome Type

boolean

enableFontAwesome Default Value

The default value is:

true

fontAwesomeKey

API key for font-awesome

fontAwesomeKey

fontAwesomeKey Type

string

fontAwesomeKey Constraints

pattern: the string must match the following regular expression:

^[a-z0-9]{10}$

try pattern

cssThemes

Theme names to be added to the dropdown

cssThemes

cssThemes Type

string[]

externalStyleSheet

URL or URLs of external stylesheets to add to dropdown/ load

externalStyleSheet

externalStyleSheet Type

any of the folllowing: string or array (Details)

customCss

Any custom CSS overides, must be minified

customCss

customCss Type

string