nw-skeleton

Global

Members

Type Definitions

AppState

AppState Object that contains appState (store) for current app instance

Properties

Name Type Description
platformData Object Object for storing platform data variables
appData Object Object for storing app data variables
userData Object Object for storing user data variables
config Object Object for storing config variables
userConfig Object Object for storing user config variables
componentCssFiles Object Object with css data on files added by Vue components
windowState WindowState Object holding current window state variables
status StatusData Object holding current app status variables
appError ErrorData Object holding current app error variables
appOperation OperationData Object holding current app operation variables
mainLoaderTitle string App main loader title
preventClose Boolean Flag to indicate whether closing app window is permitted
preventReload Boolean Flag to indicate whether reloading app window is permitted
hasUserConfig Boolean Flag to indicate whether app has saved user config
allDebugMessages array An array holding all debug messages
debugMessages array An array holding displayed debug messages
hasDebugWindow Boolean Flag to indicate whether current window has debug window
isDebugWindow Boolean Flag to indicate whether current window is debug window
debugToFileStarted Boolean Flag to indicate whether debugging to file has already started
allUserMessages array An array holding all user messages
userMessages array An array holding displayed user messages
userMessageQueue array An array holding pending user messages
userMessagesToFileStarted Boolean Flag to indicate whether
languageData LanguageData Object containing language data and translations
availableThemes array An array holding available theme names
appInfo Object Object containing app info variables
progressData ProgressData Object containing progress bar data
headerData Object Object for app-header component data
debugData Object Object for app-debug component data
footerData Object Object for app-footer component data
mainData Object Object for app-main component data
userMessagesData Object Object for user-messages component data
appNotificationsData Object Object for app-notifications component data
modalStatus Object Object for storing modal status data
modalData Object Object for modal-dialog component data
appModals Object Object containing modal dialog definitions

AppStorageConfig

AppStorageConfig Object that contains app storage configuration

Properties

Name Type Description
type string Storage type ('localStorage' or 'filesystem')
root string Filesystem storage root dir name (under appConfig.tmpDataDir)
minify Boolean Force minified json saving

BaseInitializationOptions

BaseInitializationOptions Object that contains initialization options for BaseClass

Properties

Name Type Description
silent boolean Flag to prevent initialization log messages
manifest Object Object with manifest file (package.json) data
config Object Object with configuration data

ErrorData

ErrorData Object that contains app error data

Properties

Name Type Description
error Boolean Flag to indicate whether app has error
userMessages Boolean Flag to indicate whether app-error component should display user messages
defaultTitle string Default app-error component title
defaultText string Default app-error component text
title string Current app-error component title
text string Current app-error component text
component string Custom app-error component name

KeyboardHelperKeyCodes

Object that contains key codes for keyboardHelper

Properties

Name Type Description
debugKeys Array.<Number> An array of key codes for turning debug off or on
commandKeyCodes Array.<Number> An array of key codes for setting ctrlPressed
shiftKeyCodes Array.<Number> An array of key codes for setting shiftPressed
altKeyCodes Array.<Number> An array of key codes for setting altPressed
reloadKeyCodes Array.<Number> An array of key codes for window reloading
closeKeyCodes Array.<Number> An array of key codes for window closing
escKeyCodes Array.<Number> An array of key codes for "ESC" key
reloadCssKeyCodes Array.<Number> An array of key codes for CSS reloading

LanguageData

LanguageData Object that contains languages data

Properties

Name Type Description
currentLanguage string Code of current language
currentLocale string Current locale
availableLanguages array An array containing available language objects
translations Object Object containing translations by language code

MainConfigDebug

MainConfigDebug Object that contains main config debug data

Properties

Name Type Description
enabled Boolean Flag to enable or disable debug for main script
debugToWindow Boolean Flag to enable or disable passing debug messages to main window
debugLevel Integer Minimum debug level for logging
displayTimestamps Boolean Flag to enable or disable timestamps with log messages
debugToFile Boolean Flag to enable or disable writing log to file
saveStacksToFile Boolean Flag to enable or disable writing stacks to log file
debugToFileAppend Boolean Flag to indicate whether to append or overwrite log file
debugLogFilename String Path to main debug log file

OperationData

OperationData Object that contains app operation data

Properties

Name Type Description
cancelable Boolean Flag to indicate whether operation is cancelable
cancelling Boolean Flag to indicate whether operation is being cancelled
cancelled Boolean Flag to indicate whether operation is cancelled
operationActive Boolean Flag to indicate whether operation is active
operationVisible Boolean Flag to indicate whether operation is visible
appBusy Boolean Flag to indicate whether app status should be set to busy
useProgress Boolean Flag to indicate whether to use progress bar for operation
operationStartedTimestamp Integer Operation start timestamp
operationText string Operation text
progressText string Progress bar text
operationId string Unique operation ID
notify Boolean Flag to indicate whether user should be notified when operation finishes
hideLiveInfo Boolean Flag that controls live-info component display
hideProgressBar Boolean Flag that controls progress-bar component display

ProgressData

ProgressData Object that contains app error data

Properties

Name Type Description
animated Boolean Flag to indicate whether progress bar is animated
inProgress Boolean Flag to indicate whether progress has started
percentComplete string Current progress text displayed in progress-bar component
percentNumber Float Current progress in percents
currentStep Integer Current operation step
totalSteps Integer Total operation steps
operationText string Operation text displayed in progress-bar component
progressBarClass string Additional progress-bar component CSS class
styleObject Object Style object for progress-bar component (has only 'width' property, representing CSS width for progress bar)

StatusData

StatusData Object that contains current app status variables

Properties

Name Type Description
appLoaded Boolean Flag to indicate whether app has been loaded
appReady Boolean Flag to indicate whether app is ready
appInitialized Boolean Flag to indicate whether app has been initialized
appShuttingDown Boolean Flag to indicate whether app is shutting down
appBusy Boolean Flag to indicate whether app is busy
appStatus string Current app indicator status (idle, busy, success, working, offline, error)
appStatusChanging Boolean Flag to indicate whether app status is changing
languageInitialized Boolean Flag to indicate whether languages and translation system has been initialized
feAppInitialized Boolean Flag to indicate whether frontend app is initalized
windowMaximized Boolean Flag to indicate whether window is maximized
devToolsOpened Boolean Flag to indicate whether dev tools are opened
movingWindow Boolean Flag to indicate whether window is being moved
ctrlPressed Boolean Flag to indicate whether ctrl/cmd button is pressed
shiftPressed Boolean Flag to indicate whether shift button is pressed
altPressed Boolean Flag to indicate whether alt button is pressed
noHandlingKeys Boolean Flag to indicate whether to listen to key events for app shortcuts
windowFocused Boolean Flag to indicate whether window is focused

ThemeDefinition

Object that contains theme definition values

Properties

Name Type Description
name string Name of the theme
path string Absolute path to theme directory
extends string Name of base theme that current theme extends
initCssFiles Array.<string> Array of initial theme css files
cssFiles Array.<string> Array of theme css files
overrideCssFiles Array.<string> Array of theme css override files
initJsFiles Array.<string> Array of initial theme js files
jsFiles Array.<string> Array of theme js files

WindowState

WindowState Object that contains current window state variables

Properties

Name Type Description
title string Window title
position string Window position ('center')
x Integer Window x coordinate
y Integer Window y coordinate
width Integer Window width
height Integer Window height
maximized Boolean Flag to indicate whether window is maximized
devTools Boolean Flag to indicate whether window has devTools opened
showInTaskbar Boolean Flag to indicate whether window should be shown in taskbar
resizable Boolean Flag to indicate whether window is resizable
menu Boolean Flag to indicate whether window has menu
icon Boolean Flag to indicate whether window has icon
transparent Boolean Flag to indicate whether window is transparent
show Boolean Flag to indicate whether window is displayed by default
kiosk Boolean Flag to indicate whether window is in kiosk mode
frame Boolean Flag to indicate whether window has frame
fullscreen Boolean Flag to indicate whether window is in fullscreen