Quark Shell helps you create cross-platform (currently Mac-only, Windows version coming soon) menubar/tray app using HTML and JavaScript without writing any native code. Quark Shell exposes a JavaScript object called quark to provide system functions. Quark Shell for Mac is based on WebKit.
app/index.html is the portal of your menubar app. app/preferences/[identifier].html are the preference pages (for example, app/preferences/general.html).
To build your app:
- Delete the current
appfolder - Put your files into the
appfolder - Install CocoaPods and run
pod setup cdinto the project folder and runpod install- Open
quark-shell.xcworkspacein Xcode - Build and have fun!
Remember that Quark Shell is still a WIP. When the project is stable enough, I will definitely simplify the build process.
APIs may change rapidly before 1.0.
quark.platform // returns "mac" or "windows"
// App info (configurable in Xcode)
quark.appVersion
quark.appBundleVersion
// Enable/disable Web Inspector
quark.debug = true
// Open/close the popup window
quark.openPopup()
quark.closePopup()
// Quit application
quark.quit()
// Open URL in default browser
quark.openURL("http://pomotodo.com")
// Set menubar icon
quark.setMenubarIcon("data:image/png;base64,iVBORw...SuQmCC")
quark.setMenubarHighlightedIcon("data:image/png;base64,iVBORw...SuQmCC")
quark.resetMenubarIcon()
// Set menubar icon click action
quark.setClickAction(function () { console.log("Don’t click me!"); })
quark.setSecondaryClickAction(function () { console.log("What did I say?"); })
// Set menubar label
quark.setLabel("03:14 AM")
// Auto launch at login
quark.setLaunchAtLogin(true)
// Send system notification
quark.notify({
title: "Pomotodo",
content: "Break is over!",
time: "2038-01-19T03:14:07Z", // (optional) delivery date for scheduled notification, in ISO 8601
popupOnClick: true // popup when clicking notification
})
// Remove all scheduled notifications
quark.removeAllScheduledNotifications()
// Remove all delivered notifications from notification center
quark.removeAllDeliveredNotifications()
// Open new window
// "url" is relative to "app" folder
// Notice: You can only open one window at the same time,
// or the later window will replace the former window.
quark.newWindow({
url: "about.html",
width: 600,
height: 400,
// optional options
x: 100, y: 100, // x and y should both be provided, "center" is also a valid value
border: true, // whether the window has a border, default is true
shadow: true, // whether the window has a shadow, default is true
alwaysOnTop: false, // whether the window should always on top, default is false
alpha: 1.0 // the alpha value of the window, between 0 and 1, default is 1.0
})
// Close new window
quark.closeWindow()
// Pin/unpin pop-up window (won’t close when click outside the window)
quark.pin()
quark.unpin()
// Exchange messages between webviews
quark.emit("MessageName", "payload")
quark.on("MessageName", function(message) {
console.log(message)
})
// Show a context menu
quark.showMenu({
items: [
{label: "Test", click: function() { console.log("I am completely operational") } },
{type: "separator"},
{label: "Exit", click: function() { console.log("LIFE FUNCTION TERMINATED") } }
],
x: 100,
y: 200
])// Set global keyboard shortcut
quark.addKeyboardShortcut({
keycode: 0x7A, // F1 key
modifierFlags: 0, // no modifier key
callback: function suchCallback() {
console.log("wow")
quark.openPopup()
}
})
// Clear global keyboard shortcut
quark.clearKeyboardShortcut()Please follow NSEvent Class Reference for documentation about modifier flags.
Also, Quark Shell for Mac allows you to record shortcuts via native components in Preferences window.
quark.setupPreferences([
{"label": "General", "identifier": "general", "icon": "NSPreferencesGeneral", "height": 192},
{"label": "Account", "identifier": "account", "icon": "NSUserAccounts", "height": 102},
{"label": "Shortcut", "identifier": "shortcut", "icon": "NSAdvanced", "height": 120}
])
// Must be called after quark.setupPreferences()
quark.openPreferences()
quark.closePreferences()Quark Shell for Mac also provides some native components for preferences.
More detail: Preferences.md
// Check for update
quark.checkUpdate("https://rawgit.com/HackPlan/quark-shell-mac/master/updater/SampleAppcast.xml")
quark.checkUpdateInBackground("https://rawgit.com/HackPlan/quark-shell-mac/master/updater/SampleAppcast.xml")More detail: AutoUpdate.md
- Can I use local storage? Yes.
- Can I use WebSQL? Yes.
- Can I use IndexedDB? No, because we are using NSWebView. A future Yosemite-only version using WKWebView will support IndexedDB.
- Is Quark Shell compatible with Mac App Store? Absolutely yes.
- Do you guys have a plan for Linux version? Yes, we love Linux.
Quark Shell was originally Menubar WebKit, it was created for Pomotodo for Mac. Later on, we decided to create a Windows version based on Atom Shell. The project is highly inspired by Atom Shell, node-webkit, and MacGap. As a cross-platform project, Menubar WebKit is no longer appropriate, so we started to use Quark Shell.
Quark Shell for Mac was created by LIU Dongyuan (@xhacker) in the development of Pomotodo for Mac.
Some of the code are taken from:
Used third-party libraries:
- MASShortcut by @shpakovski
- RHPreferences by @heardrwt
- Sparkle by contributors
- LaunchAtLoginController by @Mozketo, modified by @tgunr and @jashephe.
Pull requests are welcome! If you want to do something big, please open an issue first.
MIT