API Reference

jadeview.Init(
    enableDevmod bool,     // enable developer tools
    logPath string,        // log file path (may be empty)
    dataDir string,        // data root directory (may be empty)
    appName string,        // display name, required, non-blank
    appSignature string,   // unique app identifier, >= 6 Unicode chars after trim;
                           // reverse-domain style recommended (e.g. com.example.myapp) —
                           // in JAPK mode it becomes the JADE:// URL host
    singleInstance bool,   // single-instance mode
) bool

jadeview.CreateWindow(
    url string,                    // initial URL (http(s):// or custom protocols like jade://)
    parentID uint32,               // parent window ID, 0 = top-level window
    opts *jadeview.WindowOptions,  // window options, nil = DefaultWindowOptions()
    settings *jadeview.WebViewSettings, // WebView settings, nil = library internal defaults
) uint32  // window_id (>0 success, 0 failure)

jadeview.CreateBorderlessWindow(url string, settings *WebViewSettings) uint32

jadeview.On(
    event string,                  // event name (see the constant tables below)
    handler jadeview.EventHandler, // func(windowID uint32, data string) string
) (uint32, bool)  // (callback_id, success); callback_id is used with Off

jadeview.Off(event string, cbID uint32) bool

jadeview.RegisterIPCHandler(channel string, handler jadeview.EventHandler) bool

jadeview.SendIPCMessage(windowID uint32, messageType, messageContent string) bool

// Open / save file dialogs; return result JSON (usually empty/null on cancel)
jadeview.ShowOpenDialog(p jadeview.FileDialogParams) string
jadeview.ShowSaveDialog(p jadeview.FileDialogParams) string

// FileDialogParams fields
type FileDialogParams struct {
    WindowID    uint32
    Title       string
    DefaultPath string
    ButtonLabel string
    Filters     string // JSON, e.g. `[{"name":"Images","extensions":["jpg","png"]}]`
    Properties  string // JSON array; elements per the DialogProp enum
}

// Message box; returns result JSON (with the clicked button index)
jadeview.ShowMessageBox(p jadeview.MessageBoxParams) string

type MessageBoxParams struct {
    WindowID  uint32
    Title     string
    Message   string
    Detail    string
    Buttons   string // JSON array, e.g. `["OK","Cancel"]`
    DefaultID int
    CancelID  int
    Type      string // per the MsgBoxType enum
}

// Error box (simple mode)
jadeview.ShowErrorBox(windowID uint32, title, content string) bool

jadeview.ShowOpenDialogAsync(p FileDialogParams, handler DialogResultHandler) bool
jadeview.ShowSaveDialogAsync(p FileDialogParams, handler DialogResultHandler) bool
jadeview.ShowMessageBoxAsync(p MessageBoxParams, handler DialogResultHandler) bool

// type DialogResultHandler func(result string)  // result is the result JSON

jadeview.ShowNotification(jadeview.NotificationParams{
    Summary: "Notification title",   // required
    Body:    "Notification body",
    Icon:    "",           // absolute path to an icon file
    Timeout: -1,           // milliseconds, -1 = system default
    Button1: "Open",       // buttons (optional)
    Button2: "",
    Action:  "open",       // sent back via the notification-action event
})

jadeview.TrayCreate() uint32                          // create a tray icon, returns tray_id (0=failure)
jadeview.TrayDestroy(trayID) bool
jadeview.TraySetVisible(trayID, visible) bool
jadeview.TraySetTooltip(trayID, tooltip) bool
jadeview.TraySetIconFromFile(trayID, iconPath) bool   // icon file (.ico)
jadeview.TraySetIconFromData(trayID, data []byte) bool // in-memory icon data
jadeview.TraySetMenu(trayID, items []TrayMenuItem) bool // flat table; empty slice = clear menu

items := []jadeview.TrayMenuItem{
    {Type: jadeview.TrayItem.Normal, Key: "show", Label: "Show Window"},
    {Type: jadeview.TrayItem.Submenu, Key: "theme", Label: "Theme"},
    {Type: jadeview.TrayItem.Normal, Key: "dark", Label: "Dark", ParentKey: "theme"},
    {Type: jadeview.TrayItem.Divider, Key: "sep1"},
    {Type: jadeview.TrayItem.Normal, Key: "quit", Label: "Quit", Dangerous: true},
}

jadeview.MenuItemCreate(label string, kind int, parentMenuID uint32, itemID int) uint32
// kind per the MenuKind enum; itemID comes back via the menu-item-clicked event
jadeview.MenuItemSetEnabled(menuID, enabled) bool
jadeview.MenuItemSetChecked(menuID, checked) bool
jadeview.MenuItemDestroy(menuID) bool
jadeview.SetContextMenuItems(windowID uint32, menuIDs []uint32) bool
// call inside the context-menu event callback to set the top-level items for this right-click

jadeview.SetProtocolServicePath(rootPath string, hotReload bool) (string, bool)