lightdm-webkit2-greeter/docs/docs/api/GreeterConfig.md

LightDM.GreeterConfig

Provides greeter themes with a way to access values from the greeter's config file located at /etc/lightdm/web-greeter.yml. The greeter will create an instance of this class when it starts. The instance can be accessed with the global variable: greeter_config.

greeterConfig.branding : object

Holds keys/values from the branding section of the config file.

Read only: true
Properties

Name	Type	Description
background_images_dir	string	Path to directory that contains background images for use in greeter themes.
logo	string	Path to distro logo image for use in greeter themes.
user_image	string	Default user image/avatar. This is used by greeter themes for users that have not configured a .face image.

greeterConfig.greeter : object

Holds keys/values from the greeter section of the config file.

Read only: true
Properties

Name	Type	Description
debug_mode	boolean	Greeter theme debug mode.
detect_theme_errors	boolean	Provide an option to load a fallback theme when theme errors are detected.
screensaver_timeout	number	Blank the screen after this many seconds of inactivity.
secure_mode	boolean	Don't allow themes to make remote http requests.
time_format	string	A moment.js format string to be used by the greeter to generate localized time for display.
time_language	string	Language to use when displaying the time or auto to use the system's language.
theme	string	The name of the theme to be used by the greeter.

greeterConfig.features : Object

Holds keys/values from the features section of the config file.

Properties

Name	Type	Description
battery	Boolean	Enable greeter and themes to ger battery status.
backlight	Object
backlight.enabled	Boolean	Enable greeter and themes to control display backlight.
backlight.value	Number	The amount to increase/decrease brightness by greeter.
backlight.steps	Number	How many steps are needed to do the change.