Comment on page
Renderer
This page contains all the required documentation for the Renderer and its functions/events.
getPath(path: string)
- Returns path used by Cider by name.srcPath
- src/ folderrendererPath
- renderer/ foldermainPath
- main/ pathresourcePath
- resources/ pathi18nPath
- i18n/ pathciderCache
- Cider cache paththemes
- Themesplugins
- Plugins
getLocale(language: string, key: string)
- Fetches the i18n locale for the given language.
getStoreValue(key: string)
- Gets a store value
getStore()
- Returns store
setStoreValue(key: string, value: any)
- Sets a store value
getWindow()
- Gets the renderer window
loadJSFrontend(path: string)
- Loads a JavaScript file into the renderer, this is the main method of loading front end plugins.
playback.
- Controls playback.play()
- Play.pause()
- Pause.playPause()
- Toggles playback.next()
- Next track in queue.previous()
- Previous track in queue
Cider plugins support these methods by default, however more can be made with the use of ipcMain and ipcRenderer
onReady(win)
- (Required) Executes when the back end is readyonRendererReady()
- Executes when the renderer has finished loading (app.init())onPlaybackStateDidChange(attributes)
- Executes when playback state changes, passes song attributesonNowPlayingItemDidChange(attributes)
- Executes when song changes, passes song attributesonBeforeQuit
- Executes before Cider quits
Function/Method | Usage | Details |
---|---|---|
StyleSheets.Add | | |
AddMenuEntry | | |
Objects.MenuEntry | | |
Function/Method | Usage | Details |
---|---|---|
| | |
| | |
| | |
Function/Method | Usage | Details |
---|---|---|
| | |
| | |
| | |
Last modified 1yr ago