settings

Manages shared configuration for the library.

• settings
  • static
    • .getDefaultSettings() ⇒ object
    • .updateSettings(changes)
    • .getSettings() ⇒ object
    • .getSetting(key) ⇒ *
    • .updateSetting(key, value)
    • .wrapSettingString(key, transform) ⇒ Object
    • .configureIcons()
  • inner
    • ~defaults : Defaults
    • ~Defaults : object

settings.getDefaultSettings() ⇒ object

Retrieves a copy of the default settings.

Kind: static method of settings
Returns: object - A copy of the default settings object.

settings.updateSettings(changes)

Updates multiple configuration settings.

Kind: static method of settings

Param	Type	Description
changes	object	An object containing the settings to update.

settings.getSettings() ⇒ object

Retrieves a copy of the current configuration settings.

Kind: static method of settings
Returns: object - A copy of the current settings object.

settings.getSetting(key) ⇒ *

Retrieves a specific configuration setting by key.

Kind: static method of settings
Returns: * - The value of the setting, or undefined if not found.

Param	Type	Description
key	string	The key of the setting to retrieve.

settings.updateSetting(key, value)

Updates a specific configuration setting.

Kind: static method of settings

Param	Type	Description
key	string	The key of the setting to update.
value	*	The new value for the setting.

settings.wrapSettingString(key, transform) ⇒ Object

Creates a wrapped string representation of a configuration setting. This function returns an object with a toString() method that, when called, retrieves the current value of the specified setting. This allows the setting to be used as a string literal, dynamically retrieving its value.

Kind: static method of settings
Returns: Object - An object with a toString() method that returns the (optionally transformed) setting value as a string.

Param	Type	Description
key	String	The key of the setting to wrap.
transform	function	Optional function to transform the setting's value when its string representation is requested.

settings.configureIcons()

Sets icon settings to Font Awesome icons

Kind: static method of settings

settings~defaults : Defaults

Kind: inner constant of settings

settings~Defaults : object

Default settings

Kind: inner typedef of settings
Properties

Name	Type	Description
iconClassClose	string	The CSS class string for the close icon
iconClassDragX	string	The CSS class string for the drag X icon
iconClassPrevious	string	The CSS class string for the previous icon
iconClassNext	string	The CSS class string for the next icon
cssvarPrefix	string	The prefix to use for CSS custom properties