# plugins.core.touchbar.prefs

Touch Bar Preferences Panel

# API Overview

Variables - Configurable values

defaultIconPath
maxItems
supportedExtensions

Functions - API calls offered directly by the extension

getGroupEditor
init
setGroupEditor

Fields - Variables which can only be accessed from an object returned by a constructor

enabled
lastGroup
scrollBarPosition

# API Documentation

# Variables

# defaultIconPath


Signature	`plugins.core.touchbar.prefs.defaultIconPath -> string`
Type	Variable
Description	Default Path where built-in icons are stored
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 32

# maxItems


Signature	`plugins.core.touchbar.prefs.maxItems -> number`
Type	Variable
Description	The maximum number of Touch Bar items per group.
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 52

# supportedExtensions


Signature	`plugins.core.touchbar.prefs.supportedExtensions -> string`
Type	Variable
Description	Table of supported extensions for Touch Bar Icons.
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 27

# Functions

# getGroupEditor


Signature	`plugins.core.touchbar.prefs.getGroupEditor(groupId) -> none`
Type	Function
Description	Gets the Group Editor
Parameters	groupId - Group ID
Returns	Group Editor
Notes	None
Examples	None
Source	src/plugins/core/touchbar/prefs/init.lua line 376

# init


Signature	`plugins.core.touchbar.prefs.init(deps, env) -> module`
Type	Function
Description	Initialise the Module.
Parameters	deps - Dependancies Table env - Environment Table
Returns	The Module
Notes	None
Examples	None
Source	src/plugins/core/touchbar/prefs/init.lua line 566

# setGroupEditor


Signature	`plugins.core.touchbar.prefs.setGroupEditor(groupId, editorFn) -> none`
Type	Function
Description	Sets the Group Editor
Parameters	groupId - Group ID editorFn - Editor Function
Returns	None
Notes	None
Examples	None
Source	src/plugins/core/touchbar/prefs/init.lua line 359

# Fields

# enabled


Signature	`plugins.core.touchbar.prefs.enabled <cp.prop: boolean>`
Type	Field
Description	Enable or disable Touch Bar Support.
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 37

# lastGroup


Signature	`plugins.core.touchbar.prefs.lastGroup <cp.prop: string>`
Type	Field
Description	Last group used in the Preferences Drop Down.
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 42

# scrollBarPosition


Signature	`plugins.core.touchbar.prefs.scrollBarPosition <cp.prop: string>`
Type	Field
Description	Last group used in the Preferences Drop Down.
Notes	None
Source	src/plugins/core/touchbar/prefs/init.lua line 47